tornadocontrib/go-ethereum
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
154570ebd3
go-ethereum/README.md
Taylor Gerring 154570ebd3 Cleanup README developer info
2015-04-23 13:05:37 -05:00

5.2 KiB
Raw Blame History

Ethereum Go

Ethereum Go Client © 2014 Jeffrey Wilcke.

      | Linux   | OSX | Windows | Tests

----------|---------|-----|---------|------ develop | Build+Status | Build+Status | Build+Status | Buildr+Status Coverage Status master | Build+Status | Build+Status | Build+Status | Buildr+Status Coverage Status

Bugs Stories in Ready ![Stories in Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress) Gitter

Build

Mist (GUI):

go get github.com/ethereum/go-ethereum/cmd/mist

Geth (CLI):

go get github.com/ethereum/go-ethereum/cmd/geth

As of POC-8, go-ethereum uses Godep to manage dependencies. Assuming you have your environment all set up, switch to the go-ethereum repository root folder, and build/install the executable you need:

Mist (GUI):

godep go build -v ./cmd/mist

Geth (CLI):

godep go build -v ./cmd/geth

Instead of build, you can use install which will also install the resulting binary.

For prerequisites and detailed build instructions please see the Wiki

If you intend to develop on go-ethereum, check the Developers' Guide

Automated (dev) builds

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 converts a rlp stream to interface{}.

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.