Update README.md

This commit is contained in:
Jae Kwon 2015-05-12 19:09:54 -07:00 committed by Jae Kwon
parent be90fd1e0d
commit 96631f56b0
4 changed files with 35 additions and 43 deletions

View File

@ -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):
Install the dependencies and create a new user `tmuser`
#!/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
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: <http://golang.org/doc/install> 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

View File

@ -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

View File

@ -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

View File

@ -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)