From 773e3917ecc821f49adc6bf23525e13b0b4962e4 Mon Sep 17 00:00:00 2001 From: Ethan Buchman Date: Sat, 19 May 2018 23:35:45 -0400 Subject: [PATCH] networks: update readmes --- networks/local/README.md | 15 ++++++++------- networks/remote/README.md | 1 + 2 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 networks/remote/README.md diff --git a/networks/local/README.md b/networks/local/README.md index af3b6c870..528247f18 100644 --- a/networks/local/README.md +++ b/networks/local/README.md @@ -1,28 +1,29 @@ -# Local Docker Testnet +# Local Cluster with Docker Compose ## Requirements +- [Install tendermint](/docs/install.rst) - [Install docker](https://docs.docker.com/engine/installation/) - [Install docker-compose](https://docs.docker.com/compose/install/) ## Build -Build the `tendermint` binary and the `tendermint/localnode` docker image: +Build the `tendermint` binary and the `tendermint/localnode` docker image. + +Note the binary will be mounted into the container so it can be updated without +rebuilding the image. ``` cd $GOPATH/src/github.com/tendermint/tendermint -# Install dependencies (skip if already done) -make get_tools -make get_vendor_deps - -# Build binary in ./build +# Build the linux binary in ./build make build-linux # Build tendermint/localnode image make build-docker-localnode ``` + ## Run a testnet To start a 4 node testnet run: diff --git a/networks/remote/README.md b/networks/remote/README.md new file mode 100644 index 000000000..a5c0d1109 --- /dev/null +++ b/networks/remote/README.md @@ -0,0 +1 @@ +# Remote Cluster with Terraform and Ansible