quorum/README.md

101 lines
5.6 KiB
Markdown
Raw Normal View History

## Ethereum Go
2015-02-05 12:34:47 -08:00
Ethereum Go Client © 2014 Jeffrey Wilcke.
2015-02-20 09:13:39 -08:00
| Linux | OSX | Windows | Tests
----------|---------|-----|---------|------
2015-03-28 14:04:36 -07:00
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) | N/A | [![Buildr+Status](https://travis-ci.org/ethereum/go-ethereum.svg?branch=develop)](https://travis-ci.org/ethereum/go-ethereum) [![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.svg?branch=develop)](https://coveralls.io/r/ethereum/go-ethereum?branch=develop)
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) | N/A | [![Buildr+Status](https://travis-ci.org/ethereum/go-ethereum.svg?branch=master)](https://travis-ci.org/ethereum/go-ethereum) [![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.svg?branch=master)](https://coveralls.io/r/ethereum/go-ethereum?branch=master)
2015-02-05 12:34:47 -08:00
2014-10-27 09:22:29 -07:00
[![Bugs](https://badge.waffle.io/ethereum/go-ethereum.png?label=bug&title=Bugs)](https://waffle.io/ethereum/go-ethereum)
2014-10-22 14:56:40 -07:00
[![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=ready&title=Ready)](https://waffle.io/ethereum/go-ethereum)
2015-01-24 10:09:29 -08:00
[![Stories in Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/go-ethereum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2015-01-24 09:48:19 -08:00
2014-10-27 09:14:37 -07:00
2014-10-27 09:22:29 -07:00
Build
=====
2015-01-24 10:09:29 -08:00
Mist (GUI):
2014-10-27 09:22:29 -07:00
`go get github.com/ethereum/go-ethereum/cmd/mist`
Geth (CLI):
2014-10-27 09:22:29 -07:00
2015-03-27 16:32:23 -07:00
`go get github.com/ethereum/go-ethereum/cmd/geth`
2014-10-27 09:22:29 -07:00
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), 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](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)
2014-10-27 09:22:29 -07:00
2014-10-27 09:24:43 -07:00
Automated (dev) builds
======================
2015-03-15 04:19:26 -07:00
* [Docker](https://registry.hub.docker.com/u/ethereum/client-go/)
* [OS X](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/Mist-OSX-latest.dmg)
* Ubuntu
[trusty](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-trusty/latest/ethereum-cli_0.9.0%2B192SNAPSHOT20150314224122trusty-0ubuntu1_i386.deb) |
2015-03-15 04:19:26 -07:00
[utopic](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-utopic/latest/ethereum-cli_0.9.0%2B194SNAPSHOT20150314224124utopic-0ubuntu1_i386.deb)
2014-10-27 09:24:43 -07:00
* [Windows] Coming soon™
2014-10-27 09:22:29 -07:00
Executables
===========
2014-02-14 15:04:46 -08:00
Go Ethereum comes with several wrappers/executables found in
[the `cmd` directory](https://github.com/ethereum/go-ethereum/tree/develop/cmd):
2014-11-18 11:23:17 -08:00
* `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](https://github.com/ethereum/testes) suite:
`cat file | ethtest`.
2014-11-18 11:23:17 -08:00
* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas
10000 -price 0 -dump`. See `-h` for a detailed description.
2015-01-30 05:41:14 -08:00
* `disasm` disassembles EVM code: `echo "6001" | disasm`
* `rlpdump` converts a rlp stream to `interface{}`.
2014-02-15 04:27:23 -08:00
Command line options
2014-10-27 09:22:29 -07:00
============================
2013-12-26 04:29:45 -08:00
Both `mist` and `geth` can be configured via command line options, environment variables and config files.
To get the options available:
2014-01-16 02:00:56 -08:00
```
geth -help
2014-02-08 13:16:11 -08:00
```
For further details on options, see the [wiki](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)
2014-01-11 06:27:08 -08:00
Contribution
============
If you'd like to contribute to go-ethereum please fork, fix, commit and
2014-02-14 15:04:46 -08:00
send a pull request. Commits who do not comply with the coding standards
2014-08-21 06:27:01 -07:00
are ignored (use gofmt!). If you send pull requests make absolute sure that you
2014-02-15 02:49:39 -08:00
commit on the `develop` branch and that you do not merge to master.
Commits that are directly based on master are simply ignored.
2014-02-15 02:49:29 -08:00
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.
2015-02-16 08:59:54 -08:00
See [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide)
2014-01-11 06:41:05 -08:00