From d7d09f3feab5b7d6bfd4eccdcd2cef8f7d59cd8d Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Wed, 11 Apr 2018 10:47:55 -0400 Subject: [PATCH] docs: cleanup --- docs/conf.py | 2 +- docs/index.rst | 25 +++++++++---------------- docs/sdk/install.rst | 20 +++++++------------- 3 files changed, 17 insertions(+), 30 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3af51ef959..f0fa0a634a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,7 +47,7 @@ master_doc = 'index' # General information about the project. project = u'Cosmos-SDK' -copyright = u'2017, The Authors' +copyright = u'2018, The Authors' author = u'The Authors' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/index.rst b/docs/index.rst index 80d5dd48d5..23dd1e87a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,7 +21,7 @@ SDK sdk/overview.rst sdk/install.rst - sdk/glossary.rst +.. old/glossary.rst # not completely up to date but has good content .. Basecoin .. -------- @@ -29,19 +29,17 @@ SDK .. .. toctree:: :maxdepth: 2 -.. basecoin/basics.rst -.. basecoin/extensions.rst +.. old/basecoin/basics.rst # has a decent getting-start tutorial that's relatively up to date, should be consolidated with the other getting started doc Extensions ---------- -Replay Protection -~~~~~~~~~~~~~~~~~ +.. old/basecoin/extensions.rst # probably not worth salvaging -.. toctree:: - :maxdepth: 1 +.. Replay Protection +.. ~~~~~~~~~~~~~~~~~ - x/replay-protection.rst +.. old/replay-protection.rst # not sure if worth salvaging Staking @@ -55,12 +53,7 @@ Staking staking/local-testnet.rst staking/public-testnet.rst -Extras ------- +.. IBC +.. --- -.. One maxdepth for now - -.. toctree:: - :maxdepth: 1 - - ibc.rst +.. old/ibc.rst # needs to be updated diff --git a/docs/sdk/install.rst b/docs/sdk/install.rst index b4c0ad5dac..33c1769130 100644 --- a/docs/sdk/install.rst +++ b/docs/sdk/install.rst @@ -1,17 +1,12 @@ Install ======= -If you aren't used to compile go programs and just want the released -version of the code, please head to our -`downloads `__ page to get a -pre-compiled binary for your platform. - -Usually, Cosmos SDK can be installed to +Cosmos SDK can be installed to `$GOPATH/src/github.com/cosmos/cosmos-sdk` like a normal Go program: :: - go get -u github.com/cosmos/cosmos-sdk + go get github.com/cosmos/cosmos-sdk If the dependencies have been updated with breaking changes, or if another branch is required, ``dep`` is used for dependency management. @@ -21,10 +16,9 @@ repo, the correct way to install is: :: cd $GOPATH/src/github.com/cosmos/cosmos-sdk - git pull origin master - make all + make get_vendor_deps + make install + make install_examples -This will create the ``basecoind`` and ``basecli`` binaries locally in -``./build/bin``. ``make all`` implies ``make get_vendor_deps`` and uses -``glide`` to install the correct version of all dependencies. It also tests the -code, including some cli tests to make sure your binary behaves properly. +This will install ``gaiad`` and ``gaiacli`` and four example binaries: +``basecoind``, ``basecli``, ``democoind``, and ``democli``.