cosmos-sdk/docs/README.md
gamarin2 addcfbf5cb Documentation Structure Change and Cleanup (#2808)
* Update docs/sdk/clients.md
* organize ADR directory like tendermint
* docs: move spec-proposals into spec/
* remove lotion, moved to website repo
* move getting-started to cosmos-hub, and voyager to website
* docs: move lite/ into clients/lite/
* move introduction/ content to website repo
* move resources/ content to website repo
* mv sdk/clients.md to clients/clients.md
* mv validators to cosmos-hub/validators
* move deprecated sdk/ content to _attic
* sdk/modules.md is duplicate with modules/README.md
* consolidate remianing sdk/ files into a single sdk.md
* move examples/ to docs/examples/
* mv docs/cosmos-hub to docs/gaia
* Add keys/accounts section to localnet docs
2018-11-14 11:44:17 -08:00

2.1 KiB

Welcome to the SDK Docs!

Welcome to the SDK docs!

cosmonaut reading the cosmos docs in space

Learn the SDK

SDK Intro

If you are a newcomer and would like to learn more about the Cosmos SDK, this intro is a good starting place.

SDK tutorial

If you like to learn by doing, you can follow the SDK application tutorial. It showcases how to build an SDK-based blockchain from scratch, and teaches you about the basic principles the SDK in the process.

Use the SDK

The following sections contain the information you need if you want to build a fully-functional SDK-based blockchain:

Note

: We are currently working on improving the docs. Some info might be missing. If that is the case, try the Cosmos Forum. Failing that, open an issue.

  • Introduction: Contains introductory high-level material on the Cosmos SDK.
  • Gaia: Contains all documentation related to the gaia application (current name for the Cosmos-Hub).
  • Clients: Documentation about SDK clients like the SDK Command-Line interface and the SDK Light-client.
  • Specifications: Contains SDK and modules specifications.

If you are reading this on the Cosmos Website, please know that you can find more information on github. Also if you find any issues with the documentation please open a Pull Request, or at least open an Issue to update the docs!

Join the public testnet for the Cosmos Hub

To install the latest version of the gaia application and join the public testnet, click here

Edit the Documentation

See this file for details of the build process and considerations when making changes.