go-ethereum/README.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

2014-01-08 16:42:23 -06:00
Ethereum
========
2014-01-05 13:45:32 -06:00
2014-01-08 16:42:23 -06:00
[![Build Status](https://travis-ci.org/ethereum/go-ethereum.png?branch=master)](https://travis-ci.org/ethereum/go-ethereum)
2014-01-11 08:55:12 -06:00
Ethereum Go (c) [0255c7881](https://github.com/ethereum/go-ethereum#copy)
2014-01-11 08:53:27 -06:00
2014-01-16 04:01:59 -06:00
A fair warning; Ethereum is not yet to be used in production. There's no
test-net and you aren't mining real blocks (just one which is the genesis block).
2014-01-16 04:01:59 -06:00
2014-01-11 08:53:27 -06:00
Ethereum Go is split up in several sub packages. Please refer to each
individual package for more information.
1. [ethutil](https://github.com/ethereum/ethutil-go)
2. [ethdb](https://github.com/ethereum/ethdb-go)
3. [ethwire](https://github.com/ethereum/ethwire-go)
2014-01-08 16:42:23 -06:00
Deps
====
Ethereum Go makes use of a modified `secp256k1-go` and therefor GMP.
Install
=======
2013-12-26 06:29:45 -06:00
2014-01-11 08:53:27 -06:00
```go get -u -t https://github.com/ethereum/go-ethereum```
2013-12-26 06:35:04 -06:00
2013-12-26 06:29:45 -06:00
2014-01-08 16:42:23 -06:00
Command line options
====================
2013-12-26 06:29:45 -06:00
2014-01-16 04:00:56 -06:00
```
-c launch the developer console
-m start mining fake blocks and broadcast fake messages to the net
2014-01-16 04:00:56 -06:00
```
2014-01-11 08:27:08 -06:00
Contribution
============
2014-01-11 08:41:05 -06:00
If you'd like to contribute to Ethereum Go please fork, fix, commit and
send a pull request. Commits who do not comply with the coding standards
are ignored.
Coding standards
================
Sources should be formatted according to the [Go Formatting
Style](http://golang.org/doc/effective_go.html#formatting).
Unless structs fields are supposed to be directly accesible, provide
Getters and hide the fields through Go's exporting facility.
2014-01-16 04:00:56 -06:00
When you comment put meaningfull comments. Describe in detail what you
want to achieve.
2014-01-11 08:41:05 -06:00
*wrong*
```go
// Check if the value at x is greater than y
if x > y {
// It's greater!
}
```
2014-01-11 08:53:27 -06:00
2014-01-16 04:00:56 -06:00
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!)
2014-01-11 08:55:12 -06:00
### Copy
2014-01-11 08:53:27 -06:00
69bce990a619e747b4f57483724b0e8a1732bb3b44ccf70b0dd6abd272af94550fc9d8b21232d33ebf30d38a148612f68e936094b4daeb9ea7174088a439070401 0255c78815d4f056f84c96de438ed9e38c69c0f8af24f5032248be5a79fe9071c3