Merge eth-go repository into go-ethereum

mist, etheruem have been moved to cmd/

1 files changed, 47 insertions, 13 deletions

diff --git a/README.md b/README.md
index 3d4a75797..fd60f7a6a 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,34 @@ Ethereum Go Client © 2014 Jeffrey Wilcke.
 
 Current state: Proof of Concept 0.6.7.
 
-For the development package please see the [eth-go package](https://github.com/ethereum/eth-go).
+Ethereum is currently in its testing phase. 
+For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)).
+
+Ethereum Go is split up in several sub packages Please refer to each
+individual package for more information.
+  1. [eth](https://github.com/ethereum/go-ethereum)
+  2. [ethchain](https://github.com/ethereum/go-ethereum/tree/master/ethchain)
+  3. [ethwire](https://github.com/ethereum/go-ethereum/tree/master/ethwire)
+  4. [ethdb](https://github.com/ethereum/go-ethereum/tree/master/ethdb)
+  5. [ethutil](https://github.com/ethereum/go-ethereum/tree/master/ethutil)
+  6. [ethpipe](https://github.com/ethereum/go-ethereum/tree/master/ethpipe)
+  7. [ethvm](https://github.com/ethereum/go-ethereum/tree/master/ethvm)
+  8. [ethtrie](https://github.com/ethereum/go-ethereum/tree/master/ethtrie)
+  9. [ethreact](https://github.com/ethereum/go-ethereum/tree/master/ethreact)
+  10. [ethlog](https://github.com/ethereum/go-ethereum/tree/master/ethlog)
+
+The [eth](https://github.com/ethereum/go-ethereum) is the top-level package
+of the Ethereum protocol. It functions as the Ethereum bootstrapping and
+peer communication layer. The [ethchain](https://github.com/ethereum/go-ethereum/tree/master/ethchain)
+contains the Ethereum blockchain, block manager, transaction and
+transaction handlers. The [ethwire](https://github.com/ethereum/go-ethereum/tree/master/ethwire) contains
+the Ethereum [wire protocol](http://wiki.ethereum.org/index.php/Wire_Protocol) which can be used
+to hook in to the Ethereum network. [ethutil](https://github.com/ethereum/go-ethereum/tree/master/ethutil) contains
+utility functions which are not Ethereum specific. The utility package
+contains the [patricia trie](http://wiki.ethereum.org/index.php/Patricia_Tree),
+[RLP Encoding](http://wiki.ethereum.org/index.php/RLP) and hex encoding
+helpers. The [ethdb](https://github.com/ethereum/go-ethereum/tree/master/ethdb) package
+contains the LevelDB interface and memory DB interface.
 
 Build
 =======
@@ -54,24 +81,26 @@ Mist only
 Contribution
 ============
 
-If you would like to contribute to Ethereum Go, please fork, fix, commit and
-send a pull request to the main repository. Commits which do not comply with the coding standards explained below
-will be ignored. If you send a pull request, make sure that you
-commit to the `develop` branch and that you do not merge to `master`.
-Commits that are directly based off of the `master` branch instead of the `develop` branch will be ignored.
+If you'd like to contribute to 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.
 
-To make this process simpler try following the [git flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model, as it sets this process up and streamlines work flow.
+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.
 
 Coding standards
 ================
 
-Code should be formatted according to the [Go Formatting
+Sources should be formatted according to the [Go Formatting
 Style](http://golang.org/doc/effective_go.html#formatting).
 
-Unless struct fields are supposed to be directly accessible, provide
-getters and hide the fields through Go's exporting facility.
+Unless structs fields are supposed to be directly accesible, provide
+Getters and hide the fields through Go's exporting facility.
 
-Make comments in your code meaningful and only use them when necessary. Describe in detail what your code is trying to achieve. For example, this would be redundant and unnecessary commenting:
+When you comment put meaningfull comments. Describe in detail what you
+want to achieve.
 
 *wrong*
 
@@ -82,7 +111,12 @@ if x > y {
 }
 ```
 
-Everyone reading the source code should know what this code snippet was meant to achieve, and so those are **not** meaningful comments.
+Everyone reading the source probably know what you wanted to achieve
+with above code. Those are **not** meaningful comments.
 
-While this project is constantly tested and run, code tests should be written regardless. There is not time to evaluate every person's code specifically, so it is expected of you to write tests for the code so that it does not have to be tested manually. In fact, contributing by simply writing tests is perfectly fine!
+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!)