go-ethereum/README.md

Ethereum Go

Ethereum Go Client © 2014 Jeffrey Wilcke.

      | Linux   | OSX | ARM | Windows | Tests

----------|---------|-----|-----|---------|------ develop | | | | | master | | | | |


Automated (dev) builds

• Docker
• OS X
• Ubuntu trusty | utopic
• Windows 64-bit

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions on the wiki.

Building geth requires two external dependencies, Go and GMP. You can install them using your favourite package manager. Once the dependencies are installed, run

make geth

Executables

Go Ethereum comes with several wrappers/executables found in the cmd directory:

• mist Official Ethereum Browser (ethereum GUI client)
• 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 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.
• disasm disassembles EVM code: echo "6001" | disasm
• rlpdump prints RLP structures

Command line options

Both mist and geth can be configured via command line options, environment variables and config files.

To get the options available:

geth --help

For further details on options, see the wiki

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

See Developers' Guide for more details on configuring your environment, testing, and dependency management.