From cf9a03f698dd1454d78936de2ea46dcb4afa1780 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Mon, 18 Sep 2017 16:42:24 -0400 Subject: [PATCH] docs: organize install a bit better --- docs/install.rst | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index b353aba87..1746daa9d 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,17 +1,24 @@ -Install from Source -=================== +Install Tendermint +================== + +From Binary +----------- + +To download pre-built binaries, see the `Download page `__. -This page provides instructions on installing Tendermint from source. To -download pre-built binaries, see the `Download page `__. +From Source +----------- + +You'll need `go`, maybe `glide` and the tendermint source code. Install Go ----------- +^^^^^^^^^^ Make sure you have `installed Go `__ and set the ``GOPATH``. -Install Tendermint ------------------- +Get Source Code +^^^^^^^^^^^^^^^ You should be able to install the latest with a simple @@ -19,13 +26,14 @@ You should be able to install the latest with a simple go get github.com/tendermint/tendermint/cmd/tendermint -Run ``tendermint --help`` for more. +Run ``tendermint --help`` and ``tendermint version`` to ensure your +installation worked. If the installation failed, a dependency may been updated and become incompatible with the latest Tendermint master branch. We solve this using the ``glide`` tool for dependency management. -Fist, install ``glide``: +First, install ``glide``: :: @@ -45,7 +53,7 @@ still cloned to the correct location in the ``$GOPATH``. The latest Tendermint Core version is now installed. Reinstall -~~~~~~~~~ +--------- If you already have Tendermint installed, and you make updates, simply @@ -79,7 +87,7 @@ Since the third option just uses ``glide`` right away, it should always work. Troubleshooting -~~~~~~~~~~~~~~~ +--------------- If ``go get`` failing bothers you, fetch the code using ``git``: @@ -92,7 +100,7 @@ If ``go get`` failing bothers you, fetch the code using ``git``: go install ./cmd/tendermint Run -~~~ +^^^ To start a one-node blockchain with a simple in-process application: