From f247f0c518c6e848061462e3234f32cc7d854a46 Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 15 Feb 2014 00:04:46 +0100 Subject: Added readme --- README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 000000000..3bf5697af --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +Ethereum +======== + +[![Build Status](https://travis-ci.org/ethereum/go-ethereum.png?branch=master)](https://travis-ci.org/ethereum/go-ethereum) + +Ethereum Go Development package (C) Jeffrey Wilcke + +Ethereum is currently in its testing phase. The current state is "Proof +of Concept 2". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Edge). + +Ethereum Go is split up in several sub packages Please refer to each +individual package for more information. + 1. [eth](https://github.com/ethereum/eth-go) + 2. [ethchain](https://github.com/ethereum/eth-go/tree/master/ethchain) + 3. [ethwire](https://github.com/ethereum/eth-go/tree/master/ethwire) + 4. [ethdb](https://github.com/ethereum/eth-go/tree/master/ethdb) + 5. [ethutil](https://github.com/ethereum/eth-go/tree/master/ethutil) + +The [eth](https://github.com/ethereum/eth-go) 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/eth-go/tree/master/ethchain) +contains the Ethereum blockchain, block manager, transaction and +transaction handlers. The [ethwire](https://github.com/ethereum/eth-go/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/eth-go/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/eth-go/tree/master/ethdb) package +contains the LevelDB interface and memory DB interface. + +This is the bootstrap package. Eth-go contains all the necessary code to +get a node and connectivity going. + +Build +======= + +This is the Developer package. For the development client please see +[Ethereum(G)](https://github.com/ethereum/go-ethereum). + +`go get -u github.com/ethereum/eth-go` + +Contribution +============ + +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. + +When you comment put meaningfull comments. Describe in detail what you +want to achieve. + +*wrong* + +```go +// 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!) + -- cgit v1.2.3 From 4a656eff7bbb17d590014eb258431b77d33a1ad1 Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 15 Feb 2014 11:49:39 +0100 Subject: Added git flow explanation --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3bf5697af..f6c49cc2d 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,14 @@ This is the Developer package. For the development client please see Contribution ============ -If you'd like to contribute to Ethereum Go please fork, fix, commit and +If you'd like to contribute to Eth please fork, fix, commit and send a pull request. Commits who do not comply with the coding standards -are ignored. +are ignored. 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 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 ================ -- cgit v1.2.3 From ea873304cad4b6a9f02a6686df44da8364304905 Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 6 Mar 2014 13:10:39 +0100 Subject: No longer dev --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f6c49cc2d..3553a5e35 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 2". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Edge). +of Concept 3". 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. @@ -35,7 +35,7 @@ get a node and connectivity going. Build ======= -This is the Developer package. For the development client please see +This is the Developer package. For the Ethereal client please see [Ethereum(G)](https://github.com/ethereum/go-ethereum). `go get -u github.com/ethereum/eth-go` -- cgit v1.2.3 From 6a86c517c4f4b372cad0ae1d92e926a482eac5ba Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 22 Mar 2014 11:47:27 +0100 Subject: Removed old VM code --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3553a5e35..0f0a33edb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 3". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 3.5". 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. -- cgit v1.2.3 From 16e52327a4baa5547c38965fce53b3ff40b98173 Mon Sep 17 00:00:00 2001 From: obscuren Date: Sun, 27 Apr 2014 16:50:44 +0200 Subject: Upped version number --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0f0a33edb..9d810643b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 3.5". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0". 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. -- cgit v1.2.3 From fedd4c906ff9f6139cb2d88e4f1adefbf6ea81a6 Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 5 May 2014 15:55:26 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9d810643b..0a622fdcb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC1". 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. -- cgit v1.2.3 From e22e83b19aabc7711a6cd4e95bae460142d4db04 Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 10 May 2014 16:23:50 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0a622fdcb..617a1ac8a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC1". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC3". 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. -- cgit v1.2.3 From 86d6aba0127d6f35f5dda50d08dff05581031701 Mon Sep 17 00:00:00 2001 From: obscuren Date: Tue, 13 May 2014 16:36:43 +0200 Subject: Bumped --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 617a1ac8a..72e187db7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC3". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC4". 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. -- cgit v1.2.3 From ad4ffdc9474aca48ab1d3d361797398f795a6d31 Mon Sep 17 00:00:00 2001 From: obscuren Date: Wed, 14 May 2014 21:34:13 +0200 Subject: Bumped version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 72e187db7..2627bc85e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC4". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC6". 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. -- cgit v1.2.3 From c37b3cef7dc465832761b1da6761eeaa47e368d1 Mon Sep 17 00:00:00 2001 From: obscuren Date: Tue, 20 May 2014 17:08:53 +0200 Subject: Bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2627bc85e..f6bcaad28 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC6". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC7". 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. -- cgit v1.2.3 From 8f5eddd0ba9287cfcdc0e1f114c3fb367e54c46c Mon Sep 17 00:00:00 2001 From: obscuren Date: Wed, 21 May 2014 14:04:19 +0200 Subject: Bumped --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index f6bcaad28..2b080273b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC7". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC8". 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. -- cgit v1.2.3 From 1f3f76cb092e84bd2e90950f0d43d7657eae878e Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 26 May 2014 00:38:53 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2b080273b..081d9481e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC8". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC9". 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. -- cgit v1.2.3 From 1c01e9c0958d2706c522602663da7cfc40a88600 Mon Sep 17 00:00:00 2001 From: obscuren Date: Wed, 28 May 2014 12:03:40 +0200 Subject: 10 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 081d9481e..017b77038 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC9". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC10". 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. -- cgit v1.2.3 From 76a59274bfce73ec988131804c643be743d2b4d2 Mon Sep 17 00:00:00 2001 From: Maran Date: Wed, 28 May 2014 16:19:25 +0200 Subject: Bump to RC11 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 017b77038..8190c5f2d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC10". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC11". 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. -- cgit v1.2.3 From a51dfe89c05cc12b4a8483f683ff9f49b3a8f1bd Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 9 Jun 2014 22:23:30 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8190c5f2d..b10a04c25 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC11". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC12". 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. -- cgit v1.2.3 From ff0f15f7634ca713b0ce8232a8fa63eec5c3fad7 Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 16 Jun 2014 18:25:21 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b10a04c25..4a835afbf 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC12". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC13". 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. -- cgit v1.2.3 From 7ad073fb30e92689942d938939223bd01cb5fe38 Mon Sep 17 00:00:00 2001 From: obscuren Date: Fri, 20 Jun 2014 00:47:50 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4a835afbf..dda1e3a83 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC13". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 5.0 RC14". 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. -- cgit v1.2.3 From 21e389bec5c6ce287273f5a1dd7ed5eee496616a Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 26 Jun 2014 19:04:57 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index dda1e3a83..26783d12d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 5.0 RC14". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.5.15". 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. -- cgit v1.2.3 From 7a9ff4f8d45e741625bc32fde59b3dfe90851492 Mon Sep 17 00:00:00 2001 From: obscuren Date: Tue, 1 Jul 2014 16:28:17 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 26783d12d..3ef9bba70 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 0.5.15". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.5.16". 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. -- cgit v1.2.3 From 3331bb29eaf6569925e0001f1b177c6b17b682af Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 17 Jul 2014 15:35:46 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3ef9bba70..69c6eb0ad 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 0.5.16". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.5.20". 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. -- cgit v1.2.3 From 32d125131f602d63f66ee7eb09439074f0b94a91 Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 24 Jul 2014 12:04:15 +0200 Subject: Refactored to new state and vm --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 69c6eb0ad..5b0f6e07f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 0.5.20". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.6.0". 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. -- cgit v1.2.3 From d90ae4d45bb19b1b4f807b0c3b79a0236c6635ec Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 21 Aug 2014 15:24:19 +0200 Subject: Prot 0.6.3 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5b0f6e07f..17e74892e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 0.6.0". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.6.3". 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. -- cgit v1.2.3 From 15ef3388c177c59b93c96e9f0663c907d2ad1829 Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 21 Aug 2014 15:27:01 +0200 Subject: Doc --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 17e74892e..3ed340612 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,11 @@ individual package for more information. 3. [ethwire](https://github.com/ethereum/eth-go/tree/master/ethwire) 4. [ethdb](https://github.com/ethereum/eth-go/tree/master/ethdb) 5. [ethutil](https://github.com/ethereum/eth-go/tree/master/ethutil) + 6. [ethpipe](https://github.com/ethereum/eth-go/tree/master/ethpipe) + 7. [ethvm](https://github.com/ethereum/eth-go/tree/master/ethvm) + 8. [ethtrie](https://github.com/ethereum/eth-go/tree/master/ethtrie) + 9. [ethreact](https://github.com/ethereum/eth-go/tree/master/ethreact) + 10. [ethlog](https://github.com/ethereum/eth-go/tree/master/ethlog) The [eth](https://github.com/ethereum/eth-go) is the top-level package of the Ethereum protocol. It functions as the Ethereum bootstrapping and @@ -45,7 +50,7 @@ Contribution If you'd like to contribute to Eth please fork, fix, commit and send a pull request. Commits who do not comply with the coding standards -are ignored. If you send pull requests make absolute sure that you +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. -- cgit v1.2.3 From 5196f9a340d3e867bbff2e317a3c0697377da1cf Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 21 Aug 2014 20:22:39 +0200 Subject: bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3ed340612..ae624d84a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 0.6.3". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.6.4". 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. -- cgit v1.2.3 From 740081e2f7f3f76f7522753fd3c714e57ea22f3f Mon Sep 17 00:00:00 2001 From: obscuren Date: Thu, 21 Aug 2014 21:06:42 +0200 Subject: Storage at changed to return bytes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index ae624d84a..a80ed34b0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Ethereum Ethereum Go Development package (C) Jeffrey Wilcke Ethereum is currently in its testing phase. The current state is "Proof -of Concept 0.6.4". For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). +of Concept 0.6.5". 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. -- cgit v1.2.3 From b94dfc8d3a19ade4b93c96ad26800486409c7bfc Mon Sep 17 00:00:00 2001 From: Thibauld Favre Date: Fri, 17 Oct 2014 19:14:16 -0400 Subject: Update documentation and install.sh script to reflect renaming from ethereal to mist --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d54399177..ba7ebebf6 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ For the development package please see the [eth-go package](https://github.com/e Build ======= -To build Ethereal (GUI): +To build Mist (GUI): -`go get github.com/ethereum/go-ethereum/ethereal` +`go get github.com/ethereum/go-ethereum/mist` To build the node (CLI): @@ -28,7 +28,7 @@ General command line options ==================== ``` -Shared between ethereum and ethereal +Shared between ethereum and Mist -id Set the custom identifier of the client (shows up on other clients) -port Port on which the server will accept incomming connections -upnp Enable UPnP @@ -46,7 +46,7 @@ ethereum [options] [filename] filename Load the given file and interpret as JavaScript -m Start mining blocks -Etheral only +Mist only -asset_path absolute path to GUI assets directory ``` -- cgit v1.2.3 From 350b0b1f66b872c7fd80101d712b3c4c567c1f52 Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 18 Oct 2014 13:50:48 +0200 Subject: Re-enabled Travis --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index a80ed34b0..840150eae 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ Ethereum ======== -[![Build Status](https://travis-ci.org/ethereum/go-ethereum.png?branch=master)](https://travis-ci.org/ethereum/go-ethereum) +Master: [![Build Status](https://travis-ci.org/ethereum/eth-go.png?branch=master)](https://travis-ci.org/ethereum/eth-go) +Develop: [![Build Status](https://travis-ci.org/ethereum/eth-go.png?branch=develop)](https://travis-ci.org/ethereum/eth-go) Ethereum Go Development package (C) Jeffrey Wilcke -- cgit v1.2.3 From bd2862aec613ab1bca7b18884ca0a2fac3f9c2d2 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Thu, 23 Oct 2014 15:06:26 +0200 Subject: fix 'go get' commands in after the move to cmd/ --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fd60f7a6a..c28ce4607 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,11 @@ Build To build Mist (GUI): -`go get github.com/ethereum/go-ethereum/mist` +`go get github.com/ethereum/go-ethereum/cmd/mist` To build the node (CLI): -`go get github.com/ethereum/go-ethereum/ethereum` +`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)) -- cgit v1.2.3 From 2b02d812533be4b0fe59054a144ee01e157aa954 Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 27 Oct 2014 17:14:37 +0100 Subject: Added in progress to readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index c28ce4607..5488ad595 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ [![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=ready&title=Ready)](https://waffle.io/ethereum/go-ethereum) +[![Stories in +Ready](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) + Ethereum ======== -- cgit v1.2.3 From 9d386033effb0e0358fb191b38f6931f23b1eb5c Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 27 Oct 2014 17:16:03 +0100 Subject: Added bug --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5488ad595..1742f62a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=bug&title=Bugs)](https://waffle.io/ethereum/go-ethereum) [![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=ready&title=Ready)](https://waffle.io/ethereum/go-ethereum) [![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) -- cgit v1.2.3 From 1e55fe3aa21a3e5d775b00a9adcefdf17e25bb88 Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 27 Oct 2014 17:22:29 +0100 Subject: Updated readme --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1742f62a8..659f9e417 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -[![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=bug&title=Bugs)](https://waffle.io/ethereum/go-ethereum) +[![Bugs](https://badge.waffle.io/ethereum/go-ethereum.png?label=bug&title=Bugs)](https://waffle.io/ethereum/go-ethereum) [![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=ready&title=Ready)](https://waffle.io/ethereum/go-ethereum) [![Stories in -Ready](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) +Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) Ethereum ======== @@ -12,10 +12,28 @@ Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20 Ethereum Go Client © 2014 Jeffrey Wilcke. -Current state: Proof of Concept 0.6.7. +Current state: Proof of Concept 0.7 Ethereum is currently in its testing phase. -For build instructions see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)). + +Build +===== + +To build Mist (GUI): + +`go get github.com/ethereum/go-ethereum/cmd/mist` + +To build the node (CLI): + +`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)) + +Automated (dev) builds: [OS X (Windows, Linux are Coming +Soon™)](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/latest/app/) + +Packages +======== Ethereum Go is split up in several sub packages Please refer to each individual package for more information. @@ -43,21 +61,8 @@ contains the [patricia trie](http://wiki.ethereum.org/index.php/Patricia_Tree), helpers. The [ethdb](https://github.com/ethereum/go-ethereum/tree/master/ethdb) package contains the LevelDB interface and memory DB interface. -Build -======= - -To build Mist (GUI): - -`go get github.com/ethereum/go-ethereum/cmd/mist` - -To build the node (CLI): - -`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)) - General command line options -==================== +============================ ``` Shared between ethereum and Mist -- cgit v1.2.3 From 5920aa7be6fb973c7cbae34c9d4af03665933c51 Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 27 Oct 2014 17:24:43 +0100 Subject: Updated readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 659f9e417..3d4cb171a 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,12 @@ To build the node (CLI): For further, detailed, build instruction please see the [Wiki](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum(Go)) -Automated (dev) builds: [OS X (Windows, Linux are Coming -Soon™)](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/latest/app/) +Automated (dev) builds +====================== + +* [[OS X](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/latest/app/)] +* [Windows] Coming soon™ +* [Linux] Coming soon™ Packages ======== -- cgit v1.2.3 From 9509322ecd8e709ce8a17442836b6ff15ba2edff Mon Sep 17 00:00:00 2001 From: obscuren Date: Mon, 10 Nov 2014 13:36:53 +0100 Subject: Updated readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3d4cb171a..367387390 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,19 @@ Mist only -asset_path absolute path to GUI assets directory ``` +Tools +===== + +Go Ethereum comes with several binaries: + +* `mist` Official Ethereum Browser +* `ethereum` Ethereum CLI +* `ethtest` test tool which runs with the [tests](https://github.com/ethereum/testes) suit: + `ethtest "`cat myfile.json`"`. +* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas + 10000 -price 0 -dump`. See `-h` for a detailed description. + + Contribution ============ -- cgit v1.2.3 From 437d79f09418b24693b4e3fc4d2f88e291b5340f Mon Sep 17 00:00:00 2001 From: obscuren Date: Tue, 18 Nov 2014 20:23:17 +0100 Subject: Updated readme --- README.md | 68 +++++++++++++++++++++------------------------------------------ 1 file changed, 23 insertions(+), 45 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 367387390..564e5c56d 100644 --- a/README.md +++ b/README.md @@ -36,50 +36,40 @@ Automated (dev) builds * [Windows] Coming soon™ * [Linux] Coming soon™ -Packages +Binaries ======== -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. +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: + `ethtest "`cat myfile.json`"`. +* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas + 10000 -price 0 -dump`. See `-h` for a detailed description. General command line options ============================ ``` -Shared between ethereum and Mist +== Shared between ethereum and Mist == + += Settings -id Set the custom identifier of the client (shows up on other clients) -port Port on which the server will accept incomming connections -upnp Enable UPnP -maxpeer Desired amount of peers -rpc Start JSON RPC - -dir Data directory used to store configs and databases --import Import a private key --genaddr Generates a new address and private key (destructive action) --h This + += 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 Ethereum only ethereum [options] [filename] @@ -87,23 +77,11 @@ ethereum [options] [filename] filename Load the given file and interpret as JavaScript -m Start mining blocks -Mist only +== Mist only == + -asset_path absolute path to GUI assets directory ``` -Tools -===== - -Go Ethereum comes with several binaries: - -* `mist` Official Ethereum Browser -* `ethereum` Ethereum CLI -* `ethtest` test tool which runs with the [tests](https://github.com/ethereum/testes) suit: - `ethtest "`cat myfile.json`"`. -* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas - 10000 -price 0 -dump`. See `-h` for a detailed description. - - Contribution ============ -- cgit v1.2.3