2014-10-27 16:22:29 +00:00
[](https://waffle.io/ethereum/go-ethereum)
2014-10-22 21:56:40 +00:00
[](https://waffle.io/ethereum/go-ethereum)
2015-01-24 18:09:29 +00:00
[](http://waffle.io/ethereum/go-ethereum)
[](https://gitter.im/ethereum/go-ethereum?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
2015-01-24 17:48:19 +00:00
2014-10-27 16:14:37 +00:00
2015-01-24 18:09:29 +00:00
Ethereum PoC-8
2014-01-08 22:42:23 +00:00
========
2014-01-05 19:45:32 +00:00
2015-01-24 18:09:29 +00:00
* [](http://build.ethdev.com:8010/builders/Linux%20Go%20master%20branch/builds/-1) master
* [](http://build.ethdev.com:8010/builders/Linux%20Go%20develop%20branch/builds/-1) develop
* [](https://travis-ci.org/ethereum/go-ethereum) travis-ci
2015-01-31 00:47:25 +00:00
* [](https://coveralls.io/r/ethereum/go-ethereum?branch=develop)
2014-07-30 13:33:42 +00:00
2014-04-07 19:58:36 +00:00
Ethereum Go Client © 2014 Jeffrey Wilcke.
2014-01-11 14:53:27 +00:00
2014-10-27 16:22:29 +00:00
Build
=====
2015-01-24 18:09:29 +00:00
Mist (GUI):
2014-10-27 16:22:29 +00:00
`go get github.com/ethereum/go-ethereum/cmd/mist`
2015-01-24 18:09:29 +00:00
Ethereum (CLI):
2014-10-27 16:22:29 +00:00
`go get github.com/ethereum/go-ethereum/cmd/ethereum`
For further, detailed, build instruction please see the [Wiki ](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go ))
2014-10-27 16:24:43 +00:00
Automated (dev) builds
======================
* [[OS X ](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/latest/app/ )]
* [Windows] Coming soon™
* [Linux] Coming soon™
2014-10-27 16:22:29 +00:00
2014-11-18 19:23:17 +00:00
Binaries
2014-10-27 16:22:29 +00:00
========
2014-02-14 23:04:46 +00:00
2014-11-18 19:23:17 +00:00
Go Ethereum comes with several binaries found in
[cmd ](https://github.com/ethereum/go-ethereum/tree/master/cmd ):
* `mist` Official Ethereum Browser
* `ethereum` Ethereum CLI
* `ethtest` test tool which runs with the [tests ](https://github.com/ethereum/testes ) suit:
2015-01-22 21:42:39 +00:00
`cat file | ethtest` .
2014-11-18 19:23:17 +00:00
* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas
10000 -price 0 -dump`. See `-h` for a detailed description.
2015-01-24 18:09:29 +00:00
* `rlpdump` converts a rlp stream to `interface{}` .
* `peerserver` simple P2P (noi-ethereum) peer server.
2015-01-30 13:41:14 +00:00
* `disasm` disassembles EVM code: `echo "6001" | disasm`
2014-02-15 12:27:23 +00:00
2014-03-30 20:03:29 +00:00
General command line options
2014-10-27 16:22:29 +00:00
============================
2013-12-26 12:29:45 +00:00
2014-01-16 10:00:56 +00:00
```
2014-11-18 19:23:17 +00:00
== Shared between ethereum and Mist ==
= Settings
2014-05-30 14:56:56 +00:00
-id Set the custom identifier of the client (shows up on other clients)
-port Port on which the server will accept incomming connections
2014-05-20 20:13:39 +00:00
-upnp Enable UPnP
2014-05-30 14:56:56 +00:00
-maxpeer Desired amount of peers
-rpc Start JSON RPC
2014-05-20 20:13:39 +00:00
-dir Data directory used to store configs and databases
2014-11-18 19:23:17 +00:00
= Utility
-h This
-import Import a private key
-genaddr Generates a new address and private key (destructive action)
-dump Dump a specific state of a block to stdout given the -number or -hash
-difftool Supress all output and prints VM output to stdout
-diff vm=only vm output, all=all output including state storage
2014-01-11 14:27:08 +00:00
2014-05-20 20:13:39 +00:00
Ethereum only
ethereum [options] [filename]
2014-05-21 12:04:11 +00:00
-js Start the JavaScript REPL
filename Load the given file and interpret as JavaScript
2014-05-30 14:14:46 +00:00
-m Start mining blocks
2014-02-08 21:16:11 +00:00
2014-11-18 19:23:17 +00:00
== Mist only ==
2014-05-20 20:13:39 +00:00
-asset_path absolute path to GUI assets directory
2014-02-08 21:16:11 +00:00
```
2014-01-11 14:27:08 +00:00
Contribution
============
2014-10-23 13:01:27 +00:00
If you'd like to contribute to Ethereum please fork, fix, commit and
2014-02-14 23:04:46 +00:00
send a pull request. Commits who do not comply with the coding standards
2014-08-21 13:27:01 +00:00
are ignored (use gofmt!). If you send pull requests make absolute sure that you
2014-02-15 10:49:39 +00: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 10:49:29 +00:00
2014-02-15 10:49:39 +00:00
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.
2014-01-11 14:41:05 +00:00
Coding standards
================
2014-02-14 23:04:46 +00:00
Sources should be formatted according to the [Go Formatting
2014-01-11 14:41:05 +00:00
Style](http://golang.org/doc/effective_go.html#formatting).
2014-02-14 23:04:46 +00:00
Unless structs fields are supposed to be directly accesible, provide
Getters and hide the fields through Go's exporting facility.
2014-01-11 14:41:05 +00:00
2015-01-30 13:41:14 +00:00
When you comment put meaningful comments. Describe in detail what you
2014-02-14 23:04:46 +00:00
want to achieve.
2014-01-11 14:41:05 +00:00
*wrong*
```go
// Check if the value at x is greater than y
if x > y {
// It's greater!
}
```
2014-01-11 14:53:27 +00:00
2014-02-14 23:04:46 +00:00
Everyone reading the source probably know what you wanted to achieve
with above code. Those are **not** meaningful comments.
2014-01-16 10:00:56 +00:00
2014-02-14 23:04:46 +00:00
While the project isn't 100% tested I want you to write tests non the
less. I haven't got time to evaluate everyone's code in detail so I
expect you to write tests for me so I don't have to test your code
manually. (If you want to contribute by just writing tests that's fine
too!)
2014-01-16 10:00:56 +00:00
2015-01-24 18:09:29 +00:00
