LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

docs: cleanup

Browse Source
This commit is contained in:
Zach Ramsay 2018-04-11 10:47:55 -04:00
parent 15011eaf22
commit d7d09f3fea
3 changed files with 17 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -47,7 +47,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Cosmos-SDK' project = u'Cosmos-SDK'
copyright = u'2017, The Authors' copyright = u'2018, The Authors'
author = u'The Authors' author = u'The Authors'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for

25
docs/index.rst
View File

@ -21,7 +21,7 @@ SDK
sdk/overview.rst sdk/overview.rst
sdk/install.rst sdk/install.rst
sdk/glossary.rst .. old/glossary.rst # not completely up to date but has good content
.. Basecoin .. Basecoin
.. -------- .. --------
@ -29,19 +29,17 @@ SDK
.. .. toctree:: .. .. toctree::
:maxdepth: 2 :maxdepth: 2
.. basecoin/basics.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
.. basecoin/extensions.rst
Extensions Extensions
---------- ----------
Replay Protection .. old/basecoin/extensions.rst # probably not worth salvaging
~~~~~~~~~~~~~~~~~
.. toctree:: .. Replay Protection
:maxdepth: 1 .. ~~~~~~~~~~~~~~~~~
x/replay-protection.rst .. old/replay-protection.rst # not sure if worth salvaging
Staking Staking
@ -55,12 +53,7 @@ Staking
staking/local-testnet.rst staking/local-testnet.rst
staking/public-testnet.rst staking/public-testnet.rst
Extras .. IBC
------ .. ---
.. One maxdepth for now .. old/ibc.rst # needs to be updated
.. toctree::
:maxdepth: 1
ibc.rst

20
docs/sdk/install.rst
View File

@ -1,17 +1,12 @@
Install Install
======= =======
If you aren't used to compile go programs and just want the released Cosmos SDK can be installed to
version of the code, please head to our
`downloads <https://tendermint.com/download>`__ page to get a
pre-compiled binary for your platform.
Usually, Cosmos SDK can be installed to
`$GOPATH/src/github.com/cosmos/cosmos-sdk` like a normal Go program: `$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 If the dependencies have been updated with breaking changes, or if
another branch is required, ``dep`` is used for dependency management. 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 cd $GOPATH/src/github.com/cosmos/cosmos-sdk
git pull origin master make get_vendor_deps
make all make install
make install_examples
This will create the ``basecoind`` and ``basecli`` binaries locally in This will install ``gaiad`` and ``gaiacli`` and four example binaries:
``./build/bin``. ``make all`` implies ``make get_vendor_deps`` and uses ``basecoind``, ``basecli``, ``democoind``, and ``democli``.
``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.