From 0fb33ca91d13e448e7b0af36df0f2dd48c432b29 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Fri, 18 May 2018 10:12:52 -0400 Subject: [PATCH] docs: update install instructions, closes #1580 --- docs/install.rst | 59 ++++++++++++++++-------------------------------- 1 file changed, 20 insertions(+), 39 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index b2aae6766..3fc392a39 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -4,53 +4,48 @@ Install Tendermint From Binary ----------- -To download pre-built binaries, see the `Download page `__. +To download pre-built binaries, see the `releases page `__. From Source ----------- -You'll need ``go``, maybe `dep `__, and the Tendermint source code. - -Install Go -^^^^^^^^^^ - -Make sure you have `installed Go `__ and -set the ``GOPATH``. You should also put ``GOPATH/bin`` on your ``PATH``. +You'll need ``go`` `installed `__ and the required +`environment variables set `__ Get Source Code ^^^^^^^^^^^^^^^ -You should be able to install the latest with a simple - :: - go get github.com/tendermint/tendermint/cmd/tendermint - -Run ``tendermint --help`` and ``tendermint version`` to ensure your -installation worked. - -If the installation failed, a dependency may have been updated and become -incompatible with the latest Tendermint master branch. We solve this -using the ``dep`` tool for dependency management. + mkdir -p $GOPATH/src/github.com/tendermint + cd $GOPATH/src/github.com/tendermint + git clone https://github.com/tendermint/tendermint.git + cd tendermint -First, install ``dep``: +Get Tools & Dependencies +^^^^^^^^^^^^^^^^^^^^^^^^ :: - cd $GOPATH/src/github.com/tendermint/tendermint make get_tools + make get_vendor_deps -Now we can fetch the correct versions of each dependency by running: +Compile +^^^^^^^ :: - make get_vendor_deps make install -Note that even though ``go get`` originally failed, the repository was -still cloned to the correct location in the ``$GOPATH``. +to put the binary in ``$GOPATH/bin`` or use: + +:: + + make build -The latest Tendermint Core version is now installed. +to put the binary in ``./build``. + +The latest ``tendermint version`` is now installed. Reinstall --------- @@ -86,20 +81,6 @@ do, use ``dep``, as above: Since the third option just uses ``dep`` right away, it should always work. -Troubleshooting ---------------- - -If ``go get`` failing bothers you, fetch the code using ``git``: - -:: - - mkdir -p $GOPATH/src/github.com/tendermint - git clone https://github.com/tendermint/tendermint $GOPATH/src/github.com/tendermint/tendermint - cd $GOPATH/src/github.com/tendermint/tendermint - make get_tools - make get_vendor_deps - make install - Run ^^^