From de512c5923be353470a143999e65aeebc812f227 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Fri, 1 Sep 2017 21:04:34 -0400 Subject: [PATCH] fix --- docs/{images => assets}/tmint-logo-blue.png | Bin docs/index.rst | 2 +- docs/install.rst | 102 ++++++++++++++++++++ 3 files changed, 103 insertions(+), 1 deletion(-) rename docs/{images => assets}/tmint-logo-blue.png (100%) create mode 100644 docs/install.rst diff --git a/docs/images/tmint-logo-blue.png b/docs/assets/tmint-logo-blue.png similarity index 100% rename from docs/images/tmint-logo-blue.png rename to docs/assets/tmint-logo-blue.png diff --git a/docs/index.rst b/docs/index.rst index ebf4b1335..3d278f60c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Welcome to Tendermint! ====================== -.. image:: images/tmint-logo-blue.png +.. image:: assets/tmint-logo-blue.png :height: 500px :width: 500px :align: center diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 000000000..b353aba87 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,102 @@ +Install from Source +=================== + +This page provides instructions on installing Tendermint from source. To +download pre-built binaries, see the `Download page `__. + +Install Go +---------- + +Make sure you have `installed Go `__ and +set the ``GOPATH``. + +Install Tendermint +------------------ + +You should be able to install the latest with a simple + +:: + + go get github.com/tendermint/tendermint/cmd/tendermint + +Run ``tendermint --help`` for more. + +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``: + +:: + + go get github.com/Masterminds/glide + +Now we can fetch the correct versions of each dependency by running: + +:: + + cd $GOPATH/src/github.com/tendermint/tendermint + glide install + go install ./cmd/tendermint + +Note that even though ``go get`` originally failed, the repository was +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 + +:: + + cd $GOPATH/src/github.com/tendermint/tendermint + go install ./cmd/tendermint + +To upgrade, there are a few options: + +- set a new ``$GOPATH`` and run + ``go get github.com/tendermint/tendermint/cmd/tendermint``. This + makes a fresh copy of everything for the new version. +- run ``go get -u github.com/tendermint/tendermint/cmd/tendermint``, + where the ``-u`` fetches the latest updates for the repository and + its dependencies +- fetch and checkout the latest master branch in + ``$GOPATH/src/github.com/tendermint/tendermint``, and then run + ``glide install && go install ./cmd/tendermint`` as above. + +Note the first two options should usually work, but may fail. If they +do, use ``glide``, as above: + +:: + + cd $GOPATH/src/github.com/tendermint/tendermint + glide install + go install ./cmd/tendermint + +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``: + +:: + + 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 + glide install + go install ./cmd/tendermint + +Run +~~~ + +To start a one-node blockchain with a simple in-process application: + +:: + + tendermint init + tendermint node --proxy_app=dummy