plugeth/README.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

2014-01-08 22:42:23 +00:00
Ethereum
========
2014-01-05 19:45:32 +00:00
2014-01-08 22:42:23 +00:00
[![Build Status](https://travis-ci.org/ethereum/go-ethereum.png?branch=master)](https://travis-ci.org/ethereum/go-ethereum)
2014-01-11 14:55:12 +00:00
Ethereum Go (c) [0255c7881](https://github.com/ethereum/go-ethereum#copy)
2014-01-11 14:53:27 +00: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 22:42:23 +00:00
Deps
====
Ethereum Go makes use of a modified `secp256k1-go` and therefor GMP.
Install
=======
2013-12-26 12:29:45 +00:00
2014-01-11 14:53:27 +00:00
```go get -u -t https://github.com/ethereum/go-ethereum```
2013-12-26 12:35:04 +00:00
2013-12-26 12:29:45 +00:00
2014-01-08 22:42:23 +00:00
Command line options
====================
2013-12-26 12:29:45 +00:00
-c launch the developer console
-m start mining fake blocks and broadcast fake messages to the net
2014-01-11 14:27:08 +00:00
Contribution
============
2014-01-11 14:41:05 +00: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.
Don't "overcomment", meaning that your and my mom doesn't have to read
the source code.
*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-01-11 14:55:12 +00:00
### Copy
2014-01-11 14:53:27 +00:00
69bce990a619e747b4f57483724b0e8a1732bb3b44ccf70b0dd6abd272af94550fc9d8b21232d33ebf30d38a148612f68e936094b4daeb9ea7174088a439070401 0255c78815d4f056f84c96de438ed9e38c69c0f8af24f5032248be5a79fe9071c3