From 96631f56b00c7b426d1d44a00d236fecbc819b8c Mon Sep 17 00:00:00 2001 From: Jae Kwon Date: Tue, 12 May 2015 19:09:54 -0700 Subject: [PATCH] Update README.md --- INSTALL/README.md | 55 +++++++++------------------------------ INSTALL/install_env.sh | 3 ++- INSTALL/install_golang.sh | 1 + README.md | 23 +++++++++++++++- 4 files changed, 37 insertions(+), 45 deletions(-) diff --git a/INSTALL/README.md b/INSTALL/README.md index 62e9d7606..9903c5862 100644 --- a/INSTALL/README.md +++ b/INSTALL/README.md @@ -1,53 +1,22 @@ +NOTE: Only Ubuntu 14.04 64bit is supported at this time. + ### Dependencies -Install the dependencies. -[install_env.sh](https://raw.githubusercontent.com/tendermint/tendermint/master/INSTALL/install_env.sh): - - #!/bin/bash - # Run this as super user - # This part is for installing go language and setting up a user account - apt-get update -y - apt-get upgrade -y - apt-get install -y make screen gcc git mercurial libc6-dev pkg-config libgmp-dev - useradd tmuser -d /home/tmuser - usermod -aG sudo tmuser - mkdir /home/tmuser - chown -R tmuser /home/tmuser - su tmuser +Install the dependencies and create a new user `tmuser` + + curl -L https://raw.githubusercontent.com/tendermint/tendermint/master/INSTALL/install_env.sh > install_env.sh + source install_env.sh + cd /home/tmuser ### Install Go -Install Go separately, from here: or Don't use `apt-get install golang`, it's still on an old version. -[install_golang.sh](https://raw.githubusercontent.com/tendermint/tendermint/master/INSTALL/install_golang.sh): - - #!/bin/bash - # Run this as tmuser user - # This part is for installing go - - if [ `whoami` != "root" ]; - then - cd /home/tmuser - mkdir gocode - wget https://storage.googleapis.com/golang/go1.4.2.src.tar.gz - tar -xzvf go*.tar.gz - cd go/src - ./make.bash - cd /home/tmuser - cp /etc/skel/.bashrc . - mkdir -p /home/tmuser/go/src - echo 'export GOROOT=/home/tmuser/go' >> /home/tmuser/.bashrc - echo 'export GOPATH=/home/tmuser/gocode' >> /home/tmuser/.bashrc - echo 'export PATH=$PATH:$GOROOT/bin' >> /home/tmuser/.bashrc - source /home/tmuser/.bashrc - else - echo "should not be root to run install_golang.sh" - fi + + curl -L https://raw.githubusercontent.com/tendermint/tendermint/master/INSTALL/install_golang.sh > install_golang.sh + source install_golang.sh ### Install/Update Tendermint + go get -u github.com/tendermint/tendermint/cmd/tendermint # get+update go install github.com/tendermint/tendermint/cmd/tendermint # install - go get -u github.com/tendermint/tendermint/cmd/tendermint # update - - -Check out the [Developer Quick Start](https://github.com/tendermint/tendermint/wiki/Developer-Quick-Start) to learn more. + tendermint node diff --git a/INSTALL/install_env.sh b/INSTALL/install_env.sh index 0da87b750..d65441d1c 100755 --- a/INSTALL/install_env.sh +++ b/INSTALL/install_env.sh @@ -7,4 +7,5 @@ apt-get install -y make screen gcc git mercurial libc6-dev pkg-config libgmp-dev useradd tmuser -d /home/tmuser usermod -aG sudo tmuser mkdir /home/tmuser -chown -R tmuser /home/tmuser +chown -R tmuser:tmuser /home/tmuser +su tmuser diff --git a/INSTALL/install_golang.sh b/INSTALL/install_golang.sh index e2e0617ac..7939296f7 100755 --- a/INSTALL/install_golang.sh +++ b/INSTALL/install_golang.sh @@ -16,6 +16,7 @@ then echo 'export GOROOT=/home/tmuser/go' >> /home/tmuser/.bashrc echo 'export GOPATH=/home/tmuser/gocode' >> /home/tmuser/.bashrc echo 'export PATH=$PATH:$GOROOT/bin:$GOPATH/bin' >> /home/tmuser/.bashrc + source ~/.bashrc else echo "should not be root to run install_golang.sh" fi diff --git a/README.md b/README.md index cfb3e0d39..8c0fa0104 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,25 @@ Tendermint is blockchain consensus. No proof of work. -Check out the [Developer Quick Start](https://github.com/tendermint/tendermint/wiki/Developer-Quick-Start) +### Install Tendermint + +* See: https://github.com/tendermint/tendermint/tree/master/INSTALL + +### Coding style + +* Go + * Use gofmt. Consider vim-go or gosublime. + * Write godoc. + * Write tests. + * Tabs, not spaces + +### First pull request +You can make your first pull request in an hour or so! + +* Fix a bug: https://github.com/tendermint/tendermint/issues +* Write a unit test +* Pull requests that only add comments or documentation are still cool + +## Welcome aboard! + +![ship](http://i.imgur.com/Z2it1La.png)