diff --git a/docs/examples/getting-started.md b/docs/examples/getting-started.md index d7447428d..3ae42e27f 100644 --- a/docs/examples/getting-started.md +++ b/docs/examples/getting-started.md @@ -22,19 +22,22 @@ The script is also used to facilitate cluster deployment below. ### Manual Install -Requires: -- `go` minimum version 1.9.2 -- `$GOPATH` set and `$GOPATH/bin` on your $PATH (see https://github.com/tendermint/tendermint/wiki/Setting-GOPATH) +Requires: +- `go` minimum version 1.9 +- `$GOPATH` environment variable must be set +- `$GOPATH/bin` must be on your `$PATH` (see https://github.com/tendermint/tendermint/wiki/Setting-GOPATH) To install Tendermint, run: ``` go get github.com/tendermint/tendermint cd $GOPATH/src/github.com/tendermint/tendermint -make get_vendor_deps +make get_tools && make get_vendor_deps make install ``` +Note that `go get` may return an error but it can be ignored. + Confirm installation: ``` @@ -98,7 +101,7 @@ and check that it worked with: curl -s 'localhost:46657/abci_query?data="abcd"' ``` -We can send transactions with a key:value store: +We can send transactions with a key and value too: ``` curl -s 'localhost:46657/broadcast_tx_commit?tx="name=satoshi"' @@ -114,9 +117,9 @@ where the value is returned in hex. ## Cluster of Nodes -First create four Ubuntu cloud machines. The following was testing on Digital Ocean Ubuntu 16.04 x64 (3GB/1CPU, 20GB SSD). We'll refer to their respective IP addresses below as IP1, IP2, IP3, IP4. +First create four Ubuntu cloud machines. The following was tested on Digital Ocean Ubuntu 16.04 x64 (3GB/1CPU, 20GB SSD). We'll refer to their respective IP addresses below as IP1, IP2, IP3, IP4. -Then, `ssh` into each machine, and `curl` then execute [this script](https://git.io/vNLfY): +Then, `ssh` into each machine, and execute [this script](https://git.io/vNLfY): ``` curl -L https://git.io/vNLfY | bash @@ -128,12 +131,12 @@ This will install `go` and other dependencies, get the Tendermint source code, t Next, `cd` into `docs/examples`. Each command below should be run from each node, in sequence: ``` -tendermint node --home ./node1 --proxy_app=dummy -tendermint node --home ./node2 --proxy_app=dummy --p2p.seeds IP1:46656 -tendermint node --home ./node3 --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656 -tendermint node --home ./node4 --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656,IP3:46656 +tendermint node --home ./node1 --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656,IP3:46656,IP4:46656 +tendermint node --home ./node2 --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656,IP3:46656,IP4:46656 +tendermint node --home ./node3 --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656,IP3:46656,IP4:46656 +tendermint node --home ./node4 --proxy_app=dummy --p2p.seeds IP1:46656,IP2:46656,IP3:46656,IP4:46656 ``` -Note that after the third node is started, blocks will start to stream in because >2/3 of validators (defined in the `genesis.json` have come online). Seeds can also be specified in the `config.toml`. See [this PR](https://github.com/tendermint/tendermint/pull/792) for more information about configuration options. +Note that after the third node is started, blocks will start to stream in because >2/3 of validators (defined in the `genesis.json`) have come online. Seeds can also be specified in the `config.toml`. See [this PR](https://github.com/tendermint/tendermint/pull/792) for more information about configuration options. Transactions can then be sent as covered in the single, local node example above.