From 3afaff07afeea7dbb5208d536da6efd940821db8 Mon Sep 17 00:00:00 2001 From: Zaki Manian Date: Wed, 7 Jan 2015 16:19:13 -0800 Subject: [PATCH] Improved instructions for getting started in the ReadMe --- README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/README.md b/README.md index cab3cd1c..ed95a001 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,22 @@ This project is a reference implementation of the protocol. [Go](http://golang.org) 1.2 or newer. +OpenSSL header files. `sudo apt-get install libssl-dev` on Debian/Ubuntu +//TODO OpenSSL header files for other platforms + + +###Setting up Golang + +[Install Go for your platform](https://golang.org/doc/install) + +Set up environment variables. Go requires certain environment variables to compile code. Set these in your terminal, .profile or .zshrc as appropiate. + +``` +export GOROOT=$HOME/go +export PATH=$PATH:$GOROOT/bin +export GOPATH=$HOME/gopkg +``` + ## Build [![Build Status](https://drone.io/github.com/tendermint/tendermint/status.png)](https://drone.io/github.com/tendermint/tendermint/latest) @@ -35,6 +51,71 @@ make `./tendermint daemon --help` + + +### Editing your config.json + +The file will be create in ~/.tendermint/config.json + +There is not official or testnet SeedNode yet. Will updated with an official list of seed nodes. + +//TODO Explanation of other config.json fields + +``` +{ + "Network": "tendermint_testnet0", + "LAddr": "0.0.0.0:0", + "SeedNode": "", + "DB": { + "Backend": "leveldb", + "Dir": "/home/zaki/.tendermint/data" + }, + "Alert": { + "MinInterval": 0, + "TwilioSid": "", + "TwilioToken": "", + "TwilioFrom": "", + "TwilioTo": "", + "EmailRecipients": null + }, + "SMTP": { + "User": "", + "Password": "", + "Host": "", + "Port": 0 + }, + "RPC": { + "HTTPLAddr": "0.0.0.0:0" + } +} + +``` + +You will also to need to have a genesis.json in ~/.tendermint/. This must be the common genesis.json as the network you are joining from the Seed Node + +``` +{ + "Accounts": [ + { + "Address": "6070ff17c39b2b0a64ca2bc431328037fa0f4760", + "Amount": 200000000 + } + ], + "Validators": [ + { + "PubKey": "01206bd490c212e701a2136eeea04f06fa4f287ee47e2b7a9b5d62edd84cd6ad9753", + "Amount": 100000000, + "UnbondTo": [ + { + "Address": "6070ff17c39b2b0a64ca2bc431328037fa0f4760", + "Amount": 100000000 + } + ] + } + ] +} +``` + ## Resources IRC Channel: #tendermint on freenode