Add some basic build instructions to help people get started (#50)

This commit is contained in:
dan-da 2017-05-03 13:56:03 -07:00 committed by Ignotus Peverell
parent 8ffc0c6f8e
commit 6122152003
2 changed files with 36 additions and 0 deletions

View file

@ -29,6 +29,10 @@ Find us:
* Chat: [Gitter](https://gitter.im/grin_community/Lobby).
* Mailing list: join the [~MimbleWimble team](https://launchpad.net/~mimblewimble) and subscribe on Launchpad.
## Getting Started
See the [build docs](doc/build.md).
## Philosophy

32
doc/build.md Normal file
View file

@ -0,0 +1,32 @@
# Basic Build Instructions on Linux/Unix
## Install Rust
curl https://sh.rustup.rs -sSf | sh
source $HOME/.cargo/env
or see instructions at:
https://www.rust-lang.org
## Clone Grin
git clone https://github.com/ignopeverell/grin.git
## Build Grin
cd grin
cargo build
## Exec Grin
After compiling you'll get a binary at target/debug/grin. Place that in your path. Running 'grin help' should print a helpful message. Then create 3 directories for each server (the .grin db dir is created wherever you run the command from for now). Run the first server:
serv1$ RUST_LOG#info grin server run --mine run
Let it find a few blocks. Then open a new terminal in the directory for the 2nd server and run (check 'grin help server' for the options):
serv2$ RUST_LOG#info grin server -p 13424 --seed "127.0.0.1:13414" run
You'll need to give it a little bit, as it hangs for 10 sec trying to get more peers before deciding it'll only get one. Then it will sync and process and validate new blocks that serv1 may find. The "coinbase" for each block is generated with a random private key right now. You can then run a 3rd server, seeding either with the 1st or 2nd and it should connect to both and sync as well.