diff options
| -rw-r--r-- | Gopkg.lock | 26 | ||||
| -rw-r--r-- | README.md | 54 | ||||
| -rwxr-xr-x | bin/install_tools.sh | 8 |
3 files changed, 65 insertions, 23 deletions
@@ -21,10 +21,7 @@ [[projects]] name = "github.com/naoina/toml" - packages = [ - ".", - "ast" - ] + packages = [".","ast"] revision = "e6f5723bf2a66af014955e0888881314cf294129" version = "v0.1.1" @@ -36,31 +33,14 @@ [[projects]] name = "github.com/stretchr/testify" - packages = [ - "assert", - "require", - "suite" - ] + packages = ["assert","require","suite"] revision = "f35b8ab0b5a2cef36673838d662e249dd9c94686" version = "v1.2.2" [[projects]] branch = "master" name = "github.com/syndtr/goleveldb" - packages = [ - "leveldb", - "leveldb/cache", - "leveldb/comparer", - "leveldb/errors", - "leveldb/filter", - "leveldb/iterator", - "leveldb/journal", - "leveldb/memdb", - "leveldb/opt", - "leveldb/storage", - "leveldb/table", - "leveldb/util" - ] + packages = ["leveldb","leveldb/cache","leveldb/comparer","leveldb/errors","leveldb/filter","leveldb/iterator","leveldb/journal","leveldb/memdb","leveldb/opt","leveldb/storage","leveldb/table","leveldb/util"] revision = "c4c61651e9e37fa117f53c5a906d3b63090d8445" [solve-meta] diff --git a/README.md b/README.md new file mode 100644 index 0000000..bcad369 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +DEXON Consensus Core +==================== + +## Getting Started +### Prerequisites + +- [Go 1.10](https://golang.org/dl/) or a newer version +- [dep](https://github.com/golang/dep#installation) as dependency management + +### Installation + +1. Clone the repo + ``` + git clone https://github.com/dexon-foundation/dexon-consensus-core.git + cd dexon-consensus-core + ``` + +2. Install go dependency management tool + ``` + ./bin/install_tools.sh + ``` + +3. Install all dependencies + ``` + dep ensure + ``` + +4. Setup GOAPTH, the GOPATH could be anywhere in the system. Here we use `$HOME/go`: + ``` + export GOPATH=$HOME/go + export PATH=$GOPATH/bin:$PATH + ``` + You should write these settings to your `.bashrc` file. + +### Run unit tests + +``` +make test +``` + +## Simulation + +1. Setup the configuration under `./test.toml` +2. Compile and install the cmd `dexon-simulation` + +``` +make +``` + +4. Run simulation: + +``` +dexcon-simulation -config test.toml -init +``` diff --git a/bin/install_tools.sh b/bin/install_tools.sh new file mode 100755 index 0000000..e22056b --- /dev/null +++ b/bin/install_tools.sh @@ -0,0 +1,8 @@ +#!/bin/sh + +if ! which dep >/dev/null 2>&1; then + go get -u github.com/golang/dep/cmd/dep +fi +if ! which golint >/dev/null 2>&1; then + go get -u github.com/golang/lint/golint +fi |