Skip to content

Commit

Permalink
remove INSTALL dir, add INSTALL.md, update DOCKER
Browse files Browse the repository at this point in the history
  • Loading branch information
ebuchman committed Oct 12, 2016
1 parent be3592a commit 3f4af43
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 143 deletions.
11 changes: 11 additions & 0 deletions DOCKER/README.md
@@ -1,5 +1,16 @@
# Docker

Tendermint uses docker for deployment of testnets via the [mintnet](github.com/tendermint/mintnet) tool.

For faster development iterations (ie. to avoid docker builds),
the dockerfile just sets up the OS, and tendermint is fetched/installed at runtime.

For the deterministic docker builds used in testing, see the [tests directory](https://github.com/tendermint/tendermint/tree/master/test)

# Build and run a docker image and container

These are notes for the dev team.

```
# Build base Docker image
# Make sure ./run.sh exists.
Expand Down
57 changes: 57 additions & 0 deletions INSTALL.md
@@ -0,0 +1,57 @@
# 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
```
21 changes: 0 additions & 21 deletions INSTALL/FORK_TESTNET.md

This file was deleted.

30 changes: 0 additions & 30 deletions INSTALL/README.md

This file was deleted.

63 changes: 0 additions & 63 deletions INSTALL/install_env.sh

This file was deleted.

29 changes: 0 additions & 29 deletions INSTALL/install_golang.sh

This file was deleted.

1 change: 1 addition & 0 deletions cmd/tendermint/init.go
Expand Up @@ -20,4 +20,5 @@ func init_files() {

genDoc.SaveAs(config.GetString("genesis_file"))

log.Notice("Initialized tendermint", "genesis", config.GetString("genesis_file"), "priv_validator", config.GetString("priv_validator_file"))
}

0 comments on commit 3f4af43

Please sign in to comment.