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 From 05da381c15bed6f46c6ee54e9f8bdfc6c2bb6f64 Mon Sep 17 00:00:00 2001 From: Taylor Gerring Date: Sun, 21 Dec 2014 14:36:13 -0600 Subject: Add coveralls coverage badge --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 564e5c56d..c54a555cb 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Ethereum [![Build Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20master%20branch/builds/-1) master [![Build Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20develop%20branch/builds/-1) develop +[![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.png?branch=tests)](https://coveralls.io/r/ethereum/go-ethereum?branch=tests) tests Ethereum Go Client © 2014 Jeffrey Wilcke. -- cgit v1.2.3 From 08b03afa4bb3a40d2faf6543bc884a8ece5be2a1 Mon Sep 17 00:00:00 2001 From: obscuren Date: Sun, 4 Jan 2015 14:28:08 +0100 Subject: Version bump --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c54a555cb..4830d9303 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20 Ethereum Go Client © 2014 Jeffrey Wilcke. -Current state: Proof of Concept 0.7 +Current state: Proof of Concept 0.8 Ethereum is currently in its testing phase. -- cgit v1.2.3 From 393a6c5edfa0ce270bd03b3ab83cfc002145778b Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 24 Jan 2015 18:48:19 +0100 Subject: Gitter link --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a824e9001..94891351c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![Stories in Ready](https://badge.waffle.io/ethereum/go-ethereum.png?label=ready&title=Ready)](https://waffle.io/ethereum/go-ethereum) [![Stories in Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) +[![Gitter Chat](http://img.shields.io/badge/chat-online-brightgreen.svg)](https://gitter.im/ethereum/go-ethereum) + Ethereum ======== -- cgit v1.2.3 From 48083608b513d97d9db10bbfdabb6e5f8830f08a Mon Sep 17 00:00:00 2001 From: obscuren Date: Sat, 24 Jan 2015 19:09:29 +0100 Subject: Updated readme with badges --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 94891351c..d6b0e312f 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,27 @@ [![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 -Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) -[![Gitter Chat](http://img.shields.io/badge/chat-online-brightgreen.svg)](https://gitter.im/ethereum/go-ethereum) +[![Stories in Progress](https://badge.waffle.io/ethereum/go-ethereum.svg?label=in%20progress&title=In Progress)](http://waffle.io/ethereum/go-ethereum) +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/go-ethereum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -Ethereum +Ethereum PoC-8 ======== -[![Build -Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20master%20branch/builds/-1) master [![Build -Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20develop%20branch/builds/-1) develop -[![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.png?branch=tests)](https://coveralls.io/r/ethereum/go-ethereum?branch=tests) tests +* [![Build Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20master%20branch/builds/-1) master +* [![Build Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20develop%20branch/builds/-1) develop +* [![Travis-ci](https://api.travis-ci.org/ethereum/go-ethereum.svg)](https://travis-ci.org/ethereum/go-ethereum) travis-ci +* [![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.png?branch=tests)](https://coveralls.io/r/ethereum/go-ethereum?branch=tests) Ethereum Go Client © 2014 Jeffrey Wilcke. -Current state: Proof of Concept 0.8 - -Ethereum is currently in its testing phase. - Build ===== -To build Mist (GUI): +Mist (GUI): `go get github.com/ethereum/go-ethereum/cmd/mist` -To build the node (CLI): +Ethereum (CLI): `go get github.com/ethereum/go-ethereum/cmd/ethereum` @@ -51,6 +46,8 @@ Go Ethereum comes with several binaries found in `cat file | ethtest`. * `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas 10000 -price 0 -dump`. See `-h` for a detailed description. +* `rlpdump` converts a rlp stream to `interface{}`. +* `peerserver` simple P2P (noi-ethereum) peer server. General command line options ============================ @@ -127,3 +124,4 @@ 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 0c0708076e2e53f2c85256b9fee5749cccd1d739 Mon Sep 17 00:00:00 2001 From: obscuren Date: Fri, 30 Jan 2015 14:41:14 +0100 Subject: added disasm --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d6b0e312f..d1f8dc203 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ Go Ethereum comes with several binaries found in 10000 -price 0 -dump`. See `-h` for a detailed description. * `rlpdump` converts a rlp stream to `interface{}`. * `peerserver` simple P2P (noi-ethereum) peer server. +* `disasm` disassembles EVM code: `echo "6001" | disasm` General command line options ============================ @@ -103,7 +104,7 @@ 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 +When you comment put meaningful comments. Describe in detail what you want to achieve. *wrong* -- cgit v1.2.3 From bd64ed1e9376e5c0fe167e8bb3f8c5f7c9126199 Mon Sep 17 00:00:00 2001 From: Taylor Gerring Date: Fri, 30 Jan 2015 18:47:25 -0600 Subject: Update coveralls badge to develop branch --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d1f8dc203..9c83215d0 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Ethereum PoC-8 * [![Build Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20master%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20master%20branch/builds/-1) master * [![Build Status](http://build.ethdev.com/buildstatusimage?builder=Linux%20Go%20develop%20branch)](http://build.ethdev.com:8010/builders/Linux%20Go%20develop%20branch/builds/-1) develop * [![Travis-ci](https://api.travis-ci.org/ethereum/go-ethereum.svg)](https://travis-ci.org/ethereum/go-ethereum) travis-ci -* [![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.png?branch=tests)](https://coveralls.io/r/ethereum/go-ethereum?branch=tests) +* [![Coverage Status](https://coveralls.io/repos/ethereum/go-ethereum/badge.png?branch=develop)](https://coveralls.io/r/ethereum/go-ethereum?branch=develop) Ethereum Go Client © 2014 Jeffrey Wilcke. -- cgit v1.2.3