c1bae04203
- TLDR for godep install - update executable section - cleanup - add several links to wiki |
||
|---|---|---|
| _data | ||
| accounts | ||
| cmd | ||
| compression/rle | ||
| core | ||
| crypto | ||
| eth | ||
| ethdb | ||
| ethutil | ||
| event | ||
| Godeps | ||
| javascript | ||
| logger | ||
| miner | ||
| p2p | ||
| pow | ||
| rlp | ||
| rpc | ||
| state | ||
| tests | ||
| trie | ||
| ui | ||
| vm | ||
| whisper | ||
| xeth | ||
| .gitignore | ||
| .gitmodules | ||
| .mailmap | ||
| .travis.yml | ||
| Dockerfile | ||
| gocoverage.sh | ||
| install.sh | ||
| LICENSE | ||
| README.md | ||
| update-license.go | ||
Ethereum Go
Ethereum Go Client © 2014 Jeffrey Wilcke.
| Linux | OSX | Windows | Tests
----------|---------|-----|---------|------
develop | |
| N/A |
master | |
| N/A |
Build
Mist (GUI):
go get github.com/ethereum/go-ethereum/cmd/mist
Ethereum (CLI):
go get github.com/ethereum/go-ethereum/cmd/ethereum
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
Ethereum (CLI):
godep go build -v ./cmd/ethereum
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:
mistOfficial Ethereum Browser (ethereum GUI client)ethereumEthereum CLI (ethereum command line interface client)bootnoderuns a bootstrap node for the Discovery Protocolethtesttest tool which runs with the tests suite:cat file | ethtest.evmis a generic Ethereum Virtual Machine:evm -code 60ff60ff -gas 10000 -price 0 -dump. See-hfor a detailed description.disasmdisassembles EVM code:echo "6001" | disasmrlpdumpconverts a rlp stream tointerface{}.
Command line options
Both mist and ethereum can be configured via command line options, environment variables and config files.
To get the options available:
ethereum -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.
For dependency management, we use 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: should be manually verified then commited.
To make life easier try git flow it sets this all up and streamlines your work flow.
Coding standards
Sources should be formatted according to the Go Formatting Style.
Unless structs fields are supposed to be directly accesible, provide Getters and hide the fields through Go's exporting facility.
When you comment put meaningful comments. Describe in detail what you want to achieve.
wrong
// Check if the value at x is greater than y
if x > y {
// It's greater!
}
Everyone reading the source probably know what you wanted to achieve with above code. Those are not meaningful comments.
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!)