aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzelig <viktor.tron@gmail.com>2015-03-03 02:44:29 +0800
committerzelig <viktor.tron@gmail.com>2015-03-03 02:44:29 +0800
commitc1bae042038091b67163beba13b57edca95c9017 (patch)
tree038c7fdae52088897d0a29290f317f7a38c14d34
parent65cad14f9b27db396d036f47814d4843d947ac43 (diff)
downloadgo-tangerine-c1bae042038091b67163beba13b57edca95c9017.tar.gz
go-tangerine-c1bae042038091b67163beba13b57edca95c9017.tar.zst
go-tangerine-c1bae042038091b67163beba13b57edca95c9017.zip
update README
- TLDR for godep install - update executable section - cleanup - add several links to wiki
-rw-r--r--README.md83
1 files changed, 41 insertions, 42 deletions
diff --git a/README.md b/README.md
index 18392816a..a1e39e8fa 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,25 @@ Ethereum (CLI):
`go get github.com/ethereum/go-ethereum/cmd/ethereum`
-For further, detailed, build instruction please see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go))
+As of POC-8, go-ethereum uses [Godep](https://github.com/tools/godep) to manage dependencies. Assuming you have [your environment all set up](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)), switch to the go-ethereum repository root folder, and build/install the executable you need:
+
+Mist (GUI):
+
+```
+godep go build -v ./cmd/mist
+```
+
+Ethereum (CLI):
+
+```
+godep go build -v ./cmd/ethereum
+```
+
+Instead of `build`, you can use `install` which will also install the resulting binary.
+
+For prerequisites and detailed build instructions please see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go))
+
+If you intend to develop on go-ethereum, check the [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
Automated (dev) builds
======================
@@ -34,68 +52,49 @@ Automated (dev) builds
* [Windows] Coming soon&trade;
* [Linux] Coming soon&trade;
-Binaries
-========
+Executables
+===========
-Go Ethereum comes with several binaries found in
-[cmd](https://github.com/ethereum/go-ethereum/tree/master/cmd):
+Go Ethereum comes with several wrappers/executables found in
+[the `cmd` directory](https://github.com/ethereum/go-ethereum/tree/develop/cmd):
-* `mist` Official Ethereum Browser
-* `ethereum` Ethereum CLI
-* `ethtest` test tool which runs with the [tests](https://github.com/ethereum/testes) suit:
+* `mist` Official Ethereum Browser (ethereum GUI client)
+* `ethereum` Ethereum CLI (ethereum command line interface client)
+* `bootnode` runs a bootstrap node for the Discovery Protocol
+* `ethtest` test tool which runs with the [tests](https://github.com/ethereum/testes) suite:
`cat file | ethtest`.
* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas
10000 -price 0 -dump`. See `-h` for a detailed description.
-* `rlpdump` converts a rlp stream to `interface{}`.
-* `peerserver` simple P2P (noi-ethereum) peer server.
* `disasm` disassembles EVM code: `echo "6001" | disasm`
+* `rlpdump` converts a rlp stream to `interface{}`.
-General command line options
+Command line options
============================
+Both `mist` and `ethereum` can be configured via command line options, environment variables and config files.
+
+To get the options available:
+
```
-== Shared between ethereum and Mist ==
-
-= Settings
--id Set the custom identifier of the client (shows up on other clients)
--port Port on which the server will accept incomming connections
--upnp Enable UPnP
--maxpeer Desired amount of peers
--rpc Start JSON RPC
--dir Data directory used to store configs and databases
-
-= Utility
--h This
--import Import a private key
--genaddr Generates a new address and private key (destructive action)
--dump Dump a specific state of a block to stdout given the -number or -hash
--difftool Supress all output and prints VM output to stdout
--diff vm=only vm output, all=all output including state storage
-
-Ethereum only
-ethereum [options] [filename]
--js Start the JavaScript REPL
-filename Load the given file and interpret as JavaScript
--m Start mining blocks
-
-== Mist only ==
-
--asset_path absolute path to GUI assets directory
+ethereum -help
```
+For further details on options, see the [wiki](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)
+
Contribution
============
-If you'd like to contribute to Ethereum please fork, fix, commit and
+If you'd like to contribute to go-ethereum please fork, fix, commit and
send a pull request. Commits who do not comply with the coding standards
are ignored (use gofmt!). If you send pull requests make absolute sure that you
commit on the `develop` branch and that you do not merge to master.
Commits that are directly based on master are simply ignored.
-For dependency management, we use [godep](https://github.com/tools/godep). After installing with `go get github.com/tools/godep`, run `godep restore` to ensure that changes to other repositories do not break the build. To update a dependency version (for example, to include a new upstream fix), run `go get -u <foo/bar>` then `godep update <foo/...>`. To track a new dependency, add it to the project as normal than run `godep save ./...`. Changes to the Godeps folder should be manually verified then commited.
+For dependency management, we use [godep](https://github.com/tools/godep). After installing with `go get github.com/tools/godep`, run `godep restore` to ensure that changes to other repositories do not break the build. To update a dependency version (for example, to include a new upstream fix), run `go get -u <foo/bar>` then `godep update <foo/...>`. To track a new dependency, add it to the project as normal than run `godep save ./...`. Changes to the [Godeps folder](https://github.com/ethereum/go-ethereum/tree/develop/Godeps): should be manually verified then commited.
+
+To make life easier try [git flow](http://nvie.com/posts/a-successful-git-branching-model/) it sets this all up and streamlines your work flow.
-To make life easier try [git flow](http://nvie.com/posts/a-successful-git-branching-model/) it sets
-this all up and streamlines your work flow.
+See [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
Coding standards
================