From 62f94a794802ab60ecf050b5712aa0aeaf76ab8f Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Fri, 28 Jul 2017 16:34:38 -0400 Subject: [PATCH 1/2] deduplicate install, closes https://github.com/zramsay/tendermint/issues/2 --- INSTALL.md | 58 +----------------------------------------------------- 1 file changed, 1 insertion(+), 57 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index eca4f0aa..6d90acd7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,57 +1 @@ -# Install Go - -[Install Go, set the `GOPATH`, and put `GOPATH/bin` on your `PATH`](https://github.com/tendermint/tendermint/wiki/Setting-GOPATH). - -# Install Tendermint - -You should be able to install the latest with a simple `go get -u github.com/tendermint/tendermint/cmd/tendermint`. -The `-u` makes sure all dependencies are updated as well. - -Run `tendermint version` and `tendermint --help`. - -If the install falied, see [vendored dependencies below](#vendored-dependencies). - -To start a one-node blockchain with a simple in-process application: - -``` -tendermint init -tendermint node --proxy_app=dummy -``` - -See the [application developers guide](https://github.com/tendermint/tendermint/wiki/Application-Developers) for more details on building and running applications. - - -## Vendored dependencies - -If the `go get` failed, updated dependencies may have broken the build. -Install the correct version of each dependency using `glide`. - -Fist, install `glide`: - -``` -go get github.com/Masterminds/glide -``` - -Now, fetch the dependencies and install them with `glide` and `go`: - -``` -cd $GOPATH/src/github.com/tendermint/tendermint -glide install -go install ./cmd/tendermint -``` - -Sometimes `glide install` is painfully slow. Hang in there champ. - -The latest Tendermint Core version is now installed. Check by running `tendermint version`. - -## 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 -``` +The installation guide has moved to the [docs directory](docs/guides/install-from-source) in order to easily be rendered by the website. Please update your links accordingly. From f96771e753497af8eefd773068ebcc81005294bf Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Fri, 28 Jul 2017 16:38:12 -0400 Subject: [PATCH 2/2] cleanup CONTRIBUTING.md, part of https://github.com/zramsay/tendermint/issues/7 --- CONTRIBUTING.md | 13 ------------- INSTALL.md | 2 +- 2 files changed, 1 insertion(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c68404e9..f5ceee3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,16 +75,3 @@ especially `go-p2p` and `go-rpc`, as their versions are referenced in tendermint - push to release-vX.X.X to run the extended integration tests on the CI - merge to master - merge master back to develop - - -### Automation TODOs - -- Push builds: docker, AMIs -- Update github.com/tendermint/tendermint-stable with latest master and vendored deps for debian releases - -TODO: sign releases - -## Docker - -We provide docker images for `tendermint/tendermint` and others. See the [mintnet-kubernetes](https://github.com/tendermint/mintnet-kubernetes) repo for deploying Tendermint in containers with kubernetes. -Additionally, we use docker for local testnets as part of our [test suite](https://github.com/tendermint/tendermint/tree/master/test/p2p). diff --git a/INSTALL.md b/INSTALL.md index 6d90acd7..35b5ffec 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1 +1 @@ -The installation guide has moved to the [docs directory](docs/guides/install-from-source) in order to easily be rendered by the website. Please update your links accordingly. +The installation guide has moved to the [docs directory](docs/guides/install-from-source.md) in order to easily be rendered by the website. Please update your links accordingly.