Skip to content

Commit 9113530

Browse files
committed
Add a brief description to README.MD
1 parent ce2ccbc commit 9113530

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,46 @@
11
# etc-client
22

3-
[![Build Status](https://travis-ci.org/input-output-hk/etc-client.svg?branch=master)](https://travis-ci.org/input-output-hk/etc-client)
43

54
[![CircleCI](https://circleci.com/gh/input-output-hk/etc-client/tree/master.svg?style=svg)](https://circleci.com/gh/input-output-hk/etc-client/tree/master)
65

7-
A Scala based client for Ethereum Classic.
6+
[![Coverage Status](https://coveralls.io/repos/github/input-output-hk/etc-client/badge.svg?branch=master)](https://coveralls.io/github/input-output-hk/etc-client?branch=master)
7+
8+
9+
##A Scala based client for Ethereum Classic
10+
11+
###Milestone 1 - **blockSync**.
12+
13+
**This version of the code only supports downloading the blockchain from remote peers.**
14+
15+
For the curious ...
16+
17+
In order to build the client checkout the code base and then type
18+
19+
`sbt dist`
20+
21+
in the root of the project.
22+
23+
This creates a distribution zip. Unzip that file to create a folder structure starting with
24+
25+
```
26+
etc-client-0.1
27+
```
28+
29+
From there run
30+
31+
```
32+
./bin/etc-client
33+
```
34+
35+
The client attempts to contact the remote peers configured in the configuration file and begin a
36+
`fast-sync` download. The [configuration file](https://github.com/input-output-hk/etc-client/blob/master/src/main/resources/reference.conf)
37+
settings can all be overriden in
38+
39+
`./config/application.conf`
40+
41+
The client has not been run on Windows.
42+
43+
The [next milestone](https://iohk.io/projects/ethereum-classic/#roadmap) involves executing the transactions with our new Ethereum Virtual Machine!
44+
45+
46+

0 commit comments

Comments
 (0)