Improve SDK Intro (#3149)

2018-12-19 11:41:30 -08:00
parent 7c8a76a093
commit d98745fbb2
4 changed files with 174 additions and 81 deletions
@@ -2,9 +2,6 @@

 Welcome to the SDK docs!

-
-![cosmonaut reading the cosmos docs in space](./cosmos-docs.jpg)
-
 ## Learn the SDK

 ### SDK Intro
@@ -15,20 +12,11 @@ If you are a newcomer and would like to learn more about the Cosmos SDK, this **

 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.

-## Use the SDK
+### Resources

-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](https://forum.cosmos.network). Failing that, [open an issue](https://github.com/cosmos/cosmos-sdk/issues/new).
-
- [Introduction](./intro/README.md): Contains introductory high-level material on the Cosmos SDK.
- [Gaia](./gaia/README.md): Contains all documentation related to the gaia application (current name for the Cosmos-Hub). Also contains info on how to join gaia testnets.
- [Clients](./clients/README.md): Documentation about SDK clients like the SDK Command-Line interface and the SDK Light-client.
- [Specifications](./spec/README.md): Contains SDK and modules specifications.
- [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 interract with a `gaia` full-node through REST.
-
-If you are reading this on the Cosmos Website, please know that you can find more information on [github](https://github.com/cosmos/cosmos-sdk/tree/develop/docs). Also if you find any issues with the documentation please [*open a Pull Request*](https://github.com/cosmos/cosmos-sdk/compare?expand=1), or at least [*open an Issue*](https://github.com/cosmos/cosmos-sdk/issues/new) to update the docs!
+- [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

@@ -36,6 +24,19 @@ To install the latest version of the `gaia` application (application of the Cosm

 To start your own `gaia` testnet, **click [here](./gaia/deploy-testnet.md)**

+## 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.
+
 ## Contribute

 See [this file](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md) for details of the build process and
@@ -43,4 +44,4 @@ considerations when making changes.

 ## Version

-This documentation is built from the following commit:
+ This documentation is built from the following commit: