github.com/jeffallen/go-ethereum@v1.1.4-0.20150910155051-571d3236c49c/README.md (about)

     1  ## Ethereum Go
     2  
     3  Official golang implementation of the Ethereum protocol
     4  
     5            | Linux   | OSX | ARM | Windows | Tests
     6  ----------|---------|-----|-----|---------|------
     7  develop   | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](https://build.ethdev.com/builders/Linux%20Go%20develop%20branch/builds/-1) | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](https://build.ethdev.com/builders/OSX%20Go%20develop%20branch/builds/-1) | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=ARM%20Go%20develop%20branch)](https://build.ethdev.com/builders/ARM%20Go%20develop%20branch/builds/-1) | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=Windows%20Go%20develop%20branch)](https://build.ethdev.com/builders/Windows%20Go%20develop%20branch/builds/-1) | [![Buildr+Status](https://travis-ci.org/ethereum/go-ethereum.svg?branch=develop)](https://travis-ci.org/ethereum/go-ethereum) [![codecov.io](http://codecov.io/github/ethereum/go-ethereum/coverage.svg?branch=develop)](http://codecov.io/github/ethereum/go-ethereum?branch=develop)
     8  master    | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch)](https://build.ethdev.com/builders/Linux%20Go%20master%20branch/builds/-1) | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=OSX%20Go%20master%20branch)](https://build.ethdev.com/builders/OSX%20Go%20master%20branch/builds/-1) | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=ARM%20Go%20master%20branch)](https://build.ethdev.com/builders/ARM%20Go%20master%20branch/builds/-1) | [![Build+Status](https://build.ethdev.com/buildstatusimage?builder=Windows%20Go%20master%20branch)](https://build.ethdev.com/builders/Windows%20Go%20master%20branch/builds/-1) | [![Buildr+Status](https://travis-ci.org/ethereum/go-ethereum.svg?branch=master)](https://travis-ci.org/ethereum/go-ethereum) [![codecov.io](http://codecov.io/github/ethereum/go-ethereum/coverage.svg?branch=master)](http://codecov.io/github/ethereum/go-ethereum?branch=master)
     9  
    10  [![API Reference](
    11  https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
    12  )](https://godoc.org/github.com/ethereum/go-ethereum) 
    13  [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/go-ethereum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
    14  
    15  ## Automated development builds
    16  
    17  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.
    18  
    19  * [Docker](https://registry.hub.docker.com/u/ethereum/client-go/)
    20  * [OS X](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/Mist-OSX-latest.dmg)
    21  * Ubuntu
    22    [trusty](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-trusty/latest/) |
    23    [utopic](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-utopic/latest/)
    24  * [Windows 64-bit](https://build.ethdev.com/builds/Windows%20Go%20develop%20branch/Geth-Win64-latest.zip)
    25  * [ARM](https://build.ethdev.com/builds/ARM%20Go%20develop%20branch/geth-ARM-latest.tar.bz2)
    26  
    27  ## Building the source
    28  
    29  For prerequisites and detailed build instructions please read the
    30  [Installation Instructions](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum)
    31  on the wiki.
    32  
    33  Building geth requires two external dependencies, Go and GMP.
    34  You can install them using your favourite package manager.
    35  Once the dependencies are installed, run
    36  
    37      make geth
    38  
    39  ## Executables
    40  
    41  Go Ethereum comes with several wrappers/executables found in 
    42  [the `cmd` directory](https://github.com/ethereum/go-ethereum/tree/develop/cmd):
    43  
    44   Command  |         |
    45  ----------|---------|
    46  `geth` | Ethereum CLI (ethereum command line interface client) |
    47  `bootnode` | runs a bootstrap node for the Discovery Protocol |
    48  `ethtest` | test tool which runs with the [tests](https://github.com/ethereum/tests) suite: `/path/to/test.json > ethtest --test BlockTests --stdin`.
    49  `evm` | is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas 10000 -price 0 -dump`. See `-h` for a detailed description. |
    50  `disasm` | disassembles EVM code: `echo "6001" | disasm` |
    51  `rlpdump` | prints RLP structures |
    52  
    53  ## Command line options
    54  
    55  `geth` can be configured via command line options, environment variables and config files.
    56  
    57  To get the options available:
    58  
    59      geth help
    60  
    61  For further details on options, see the [wiki](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)
    62  
    63  ## Contribution
    64  
    65  If you'd like to contribute to go-ethereum please fork, fix, commit and
    66  send a pull request. Commits who do not comply with the coding standards
    67  are ignored (use gofmt!). If you send pull requests make absolute sure that you
    68  commit on the `develop` branch and that you do not merge to master.
    69  Commits that are directly based on master are simply ignored.
    70  
    71  See [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
    72  for more details on configuring your environment, testing, and
    73  dependency management.
    74