diff --git a/README.md b/README.md index 635c7efa5566aad93a9a36f5b7aee6fad1978161..ffae3fd06c3adb1174b5a808355f5b83af814435 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,20 @@ See the [eris-db documentation](https://monax.io/docs/documentation/db/) for mor `eris-db` is intended to be used by the `eris chains` command via [eris-cli](https://monax.io/docs/documentation/cli/latest/eris_chains). Available commands such as `make | start | stop | logs | inspect | update` are used for chain lifecycle management. ### For Developers +Dependency management for eris-db is managed with [glide](github.com/Masterminds/glide), and you can build eris-db from source by following 1. [Install go](https://golang.org/doc/install) 2. Ensure you have `gmp` installed (`sudo apt-get install libgmp3-dev || brew install gmp`) -3. `go get github.com/eris-ltd/eris-db/cmd/eris-db` +3. and execute following commands in a terminal: +``` +go get github.com/Masterminds/glide +go get -d github.com/eris-ltd/eris-db +REPO=$($GOPATH/src/github.com/eris-ltd/eris-db) +cd $REPO && glide install +cd $REPO/cmd/eris-db && go install``` -To run `eris-db`, just type `$ eris-db serve --work-dir <path to chain directory>` +To run `eris-db`, just type `$ eris-db serve --work-dir <path to chain directory>`, where the chain directory needs to contain the configuration files as generated by `eris chains make`. This will start the node using the provided folder as working dir. If the path is omitted it defaults to `~/.erisdb`