docs cleanup

This commit is contained in:
Ethan Buchman 2018-03-04 00:37:01 -05:00 committed by Zach Ramsay
parent 1b9afdab48
commit 266ea5ce82
11 changed files with 7 additions and 12 deletions

View File

@ -15,7 +15,7 @@ while defining as little about that state machine as possible (staying true to t
BaseApp requires stores to be mounted via capabilities keys - handlers can only access
stores they're given the key for. The BaseApp ensures all stores are properly loaded, cached, and committed.
One mounted store is considered the "main" - it holds the latest block header, from which we can find and load the
most recent state.
most recent state ([TODO](https://github.com/cosmos/cosmos-sdk/issues/522)).
BaseApp distinguishes between two handler types - the `AnteHandler` and the `MsgHandler`.
The former is a global validity check (checking nonces, sigs and sufficient balances to pay fees,

View File

@ -6,7 +6,8 @@ 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 like a normal Go program:
Usually, Cosmos SDK can be installed to
`$GOPATH/src/github.com/cosmos/cosmos-sdk` like a normal Go program:
::
@ -23,13 +24,7 @@ repo, the correct way to install is:
git pull origin master
make all
This will create the ``basecoin`` binary in ``$GOPATH/bin``.
``make all`` implies ``make get_vendor_deps`` and uses ``dep`` to
install the correct version of all dependencies. It also tests the code,
including some cli tests to make sure your binary behaves properly.
If you need another branch, make sure to run ``git checkout <branch>``
before ``make all``. And if you switch branches a lot, especially
touching other tendermint repos, you may need to ``make fresh``
sometimes so dep doesn't get confused with all the branches and
versions lying around.
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.