cosmos-sdk/docs/README.md

48 lines
1.9 KiB
Markdown
Raw Normal View History

# Welcome to the SDK Docs!
Welcome to the SDK docs!
2018-06-16 21:18:24 -07:00
## Learn the SDK
2018-09-19 10:24:31 -07:00
### SDK Intro
If you are a newcomer and would like to learn more about the Cosmos SDK, this **[intro](./intro/README.md)** is a good starting place.
### SDK tutorial
If you like to learn by doing, you can follow the **[SDK application tutorial](https://github.com/cosmos/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.
2018-12-19 11:41:30 -08:00
### Resources
2018-12-19 11:41:30 -08:00
- [Specifications](./spec/README.md): Specifications of modules and other parts of the Cosmos SDK.
- [SDK API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk): Godocs of the Cosmos SDK.
- [REST API spec](https://cosmos.network/rpc/): List of endpoints to interact with a `gaia` full-node through REST.
## Cosmos Hub testnet
To install the latest version of the `gaia` application (application of the Cosmos Hub) and join the public testnet, **click [here](./gaia/join-testnet.md)**
To start your own `gaia` testnet, **click [here](./gaia/deploy-testnet.md)**
2018-12-19 11:41:30 -08:00
## Creating a new SDK project
To create a new project, you can either:
- Fork [this repo](https://github.com/cosmos/sdk-application-tutorial/). Do not forget to remove the `nameservice` module from the various files if you don't need it.
- Use community tools like [chainkit](https://github.com/blocklayerhq/chainkit).
## Languages
The Cosmos-SDK is currently written in [Golang](https://golang.org/), though the
framework could be implemented similarly in other languages.
Contact us for information about funding an implementation in another language.
2018-11-14 14:32:41 -08:00
## Contribute
2018-09-19 10:24:31 -07:00
2018-11-16 05:48:38 -08:00
See [this file](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md) for details of the build process and
2018-09-19 10:24:31 -07:00
considerations when making changes.
2018-11-14 14:32:41 -08:00
## Version
2018-12-19 11:41:30 -08:00
This documentation is built from the following commit: