|
|
@@ -1,19 +1,18 @@
|
|
|
## Ethereum Go
|
|
|
|
|
|
-Ethereum Go Client, by Jeffrey Wilcke (and some other people).
|
|
|
+Official golang implementation of the Ethereum protocol
|
|
|
|
|
|
| Linux | OSX | ARM | Windows | Tests
|
|
|
----------|---------|-----|-----|---------|------
|
|
|
-develop | [](https://build.ethdev.com/builders/Linux%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/OSX%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/ARM%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/Windows%20Go%20develop%20branch/builds/-1) | [](https://travis-ci.org/ethereum/go-ethereum) [](https://coveralls.io/r/ethereum/go-ethereum?branch=develop)
|
|
|
-master | [](https://build.ethdev.com/builders/Linux%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/OSX%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/ARM%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/Windows%20Go%20master%20branch/builds/-1) | [](https://travis-ci.org/ethereum/go-ethereum) [](https://coveralls.io/r/ethereum/go-ethereum?branch=master)
|
|
|
+develop | [](https://build.ethdev.com/builders/Linux%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/OSX%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/ARM%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/Windows%20Go%20develop%20branch/builds/-1) | [](https://travis-ci.org/ethereum/go-ethereum) [](http://codecov.io/github/ethereum/go-ethereum?branch=develop)
|
|
|
+master | [](https://build.ethdev.com/builders/Linux%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/OSX%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/ARM%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/Windows%20Go%20master%20branch/builds/-1) | [](https://travis-ci.org/ethereum/go-ethereum) [](http://codecov.io/github/ethereum/go-ethereum?branch=master)
|
|
|
|
|
|
-[](https://waffle.io/ethereum/go-ethereum)
|
|
|
-[](https://waffle.io/ethereum/go-ethereum)
|
|
|
-[](http://waffle.io/ethereum/go-ethereum)
|
|
|
+[](https://godoc.org/github.com/ethereum/go-ethereum)
|
|
|
[](https://gitter.im/ethereum/go-ethereum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
|
|
|
|
-Automated development builds
|
|
|
-======================
|
|
|
+## Automated development builds
|
|
|
|
|
|
The following builds are build automatically by our build servers after each push to the [develop](https://github.com/ethereum/go-ethereum/tree/develop) branch.
|
|
|
|
|
|
@@ -25,8 +24,7 @@ The following builds are build automatically by our build servers after each pus
|
|
|
* [Windows 64-bit](https://build.ethdev.com/builds/Windows%20Go%20develop%20branch/Geth-Win64-latest.zip)
|
|
|
* [ARM](https://build.ethdev.com/builds/ARM%20Go%20develop%20branch/geth-ARM-latest.tar.bz2)
|
|
|
|
|
|
-Building the source
|
|
|
-===================
|
|
|
+## Building the source
|
|
|
|
|
|
For prerequisites and detailed build instructions please read the
|
|
|
[Installation Instructions](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum)
|
|
|
@@ -38,34 +36,31 @@ Once the dependencies are installed, run
|
|
|
|
|
|
make geth
|
|
|
|
|
|
-Executables
|
|
|
-===========
|
|
|
+## Executables
|
|
|
|
|
|
Go Ethereum comes with several wrappers/executables found in
|
|
|
[the `cmd` directory](https://github.com/ethereum/go-ethereum/tree/develop/cmd):
|
|
|
|
|
|
-* `geth` 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/tests) suite:
|
|
|
- `/path/to/test.json > ethtest --test BlockTests --stdin`.
|
|
|
-* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas
|
|
|
- 10000 -price 0 -dump`. See `-h` for a detailed description.
|
|
|
-* `disasm` disassembles EVM code: `echo "6001" | disasm`
|
|
|
-* `rlpdump` prints RLP structures
|
|
|
+ Command | |
|
|
|
+----------|---------|
|
|
|
+`geth` | 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/tests) suite: `/path/to/test.json > ethtest --test BlockTests --stdin`.
|
|
|
+`evm` | is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas 10000 -price 0 -dump`. See `-h` for a detailed description. |
|
|
|
+`disasm` | disassembles EVM code: `echo "6001" | disasm` |
|
|
|
+`rlpdump` | prints RLP structures |
|
|
|
|
|
|
-Command line options
|
|
|
-====================
|
|
|
+## Command line options
|
|
|
|
|
|
`geth` can be configured via command line options, environment variables and config files.
|
|
|
|
|
|
To get the options available:
|
|
|
|
|
|
- geth --help
|
|
|
+ geth help
|
|
|
|
|
|
For further details on options, see the [wiki](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)
|
|
|
|
|
|
-Contribution
|
|
|
-============
|
|
|
+## Contribution
|
|
|
|
|
|
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
|