Merge pull request #90 from harmony-dev/feature/readme

README

README.md

@@ -1,2 +1,55 @@
-# Ethereum Beacon Chain
-Implementation of Ethereum 2.0 Beacon Chain [specification](https://github.com/ethereum/eth2.0-specs/blob/master/specs/core/0_beacon-chain.md) in Java language.
+# Beacon Chain Java
+Ethereum 2.0 Beacon chain client. Someday, definitely, it will be a fully featured Serenity client. We are working to get there. Currently there is no p2p and, hence, there is no cross client communication.
+
+## Ethereum 2.0?
+Yes, Ethereum Foundation, community and other interested parties are developing successor of [Ethereum](https://ethereum.org/) without cons :).
+New blockchain starts from [Phase 0](https://github.com/ethereum/eth2.0-specs/blob/master/specs/core/0_beacon-chain.md) also known as Beacon chain, a core of Ethereum 2.0 blockchain. Phase 1 will be the next one and so on.
+
+## Develop
+If you want to take part in Ethereum 2.0 development and use our code, we split everything into several modules, so anyone could easily take only the needed part. To dig into module goals, check [settings.gradle](settings.gradle). 
+
+You can build one module jar with gradle `assemble` task executed on desired module:
+```bash
+./gradlew :crypto:assemble
+cp crypto/build/libs/beacon-crypto-0.1.0.jar <jar-destination>
+``` 
+
+## Simulator
+Despite lacking a network stack there is already something that everybody can play with, a standalone Beacon chain simulator.
+
+To run an simulator you need to install Java 8 or later. There are many guidelines in Internet, even the [official one](https://java.com/en/download/help/download_options.xml), from Oracle. Next, git clone our repo, build `client` module distribution and run simulator:
+```bash
+git clone https://github.com/harmony-dev/beacon-chain-java.git
+cd beacon-chain-java
+./gradlew :start:cli:distZip
+``` 
+Cool, we made distribution tied to our system, it's in the `start/cli/build/distributions/` folder and looks like `cli-0.1.0.zip`. Unzip it, enter the `bin` folder and run simulator:
+```bash
+cd start/cli/build/distributions/
+unzip cli-0.1.0.zip
+cd cli-0.1.0/bin
+./simulator
+``` 
+and you will see help for `simulator` launcher. Preceding commands will work for OS X/Linux, in Windows you will need to  use `.bat` commands where its needed.
+
+Let's run simulator with default settings and 4 peers:
+```bash
+./simulator run 4
+```
+
+## Contribution guideline
+Thank you for joining our efforts to drive Ethereum forward! 
+We are not very strict on requirements but your code should help us to reach our goal, it should be easy to get it, understand the idea, and it should be feasible to review it. Also we are trying to match [Google code style](https://google.github.io/styleguide/javaguide.html) but we don't like it. Feel free to choose any [issue](https://github.com/harmony-dev/beacon-chain-java/issues) and ask how to do it better.  
+
+## Links
+[Ethereum 2.0 specs](https://github.com/ethereum/eth2.0-specs)  
+[Vitalik Buterin on DevCon4 about Ethereum 2.0](https://slideslive.com/38911602/latest-of-ethereum)
+
+
+## Licensing
+This project is licensed under Apache 2.0 license. You could use it for any commercial, private or open-source project.
+
+## Donations
+If you like the project, we could use your donations to fund the development:
+
+`0xF5eFA576ee17A381d798299d10eD397c4dce9BdD`

settings.gradle

@@ -1,19 +1,37 @@
 rootProject.name = 'beacon'
+// Chain construction services and helpers
 include 'chain'
+// Spec functions implementation, transitions etc
 include 'consensus'
+// Ethereum 2.0 domain model: data models
 include 'core'
+// Crypto utilities: BLS381-12 and hash
 include 'crypto'
+// DB persistence core interfaces 
 include 'db:core'
+// DB made around EthereumJ client
 include 'db:ethereumj'
+// PoW (Proof of Work) interfaces etc
 include 'pow:core'
+// PoW made with EthereumJ
 include 'pow:ethereumj'
+// PoW validator part
 include 'pow:validator'
+// PoW made with web3j (not ready yet)
 include 'pow:web3j'
+// SSZ (Simple serialization)
 include 'ssz'
+// Command line executable clients
 include 'start:cli'
+// Clients helpers
 include 'start:common'
+// Configuration parser
 include 'start:config'
+// Strict types definition
 include 'types'
+// Standalone utils without any relation to Ethereum 2.0
 include 'util'
+// Validator services
 include 'validator'
+// Wire API mock
 include 'wire'