From 9d9fd1c3b4cbe7421618ea8d7ac3382fa6d6ce51 Mon Sep 17 00:00:00 2001 From: daehyun Date: Sun, 10 Mar 2019 16:34:14 +0900 Subject: [PATCH] Add instruction for runnng from Docker Compose --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9cddd69bf..1edcd7d82 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Proof-of-concept Implementation of [Plasma EVM](https://hackmd.io/s/HyZ2ms8EX), forked from [Onther-Tech/plasma-evm](https://github.com/Onther-Tech/plasma-evm). You can check the RootChain smart contract [here](https://github.com/Onther-Tech/plasma-evm-contracts). - ## Development Status + - [x] Make enter / exit requests - [x] Submit NRBs / ORBs - [x] Finalize block and requests @@ -11,8 +11,29 @@ Proof-of-concept Implementation of [Plasma EVM](https://hackmd.io/s/HyZ2ms8EX), Implementing TrueBit's verification game is under research as well as challenges that requires verification game. +## Quick Start + +Make sure that you have installed **Docker Compose** for quick start. + +* For Mac or Windows: + * Download [Docker Desktop](https://www.docker.com/products/docker-desktop) for Mac or Windows. [Docker Compose](https://docs.docker.com/compose) will be automatically installed. +* For Linux: + * On Linux, make sure you have the latest version of [Compose](https://docs.docker.com/compose/install/). + + +Download Plasma EVM code and go into its directory: +``` +git clone --single-branch --branch deploydocker https://github.com/Onther-Tech/plasma-evm +cd plasma-evm +``` + +Then just run: +``` +docker-compose up +``` ## Ethereum client + Building geth requires both a Go (version 1.9 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run @@ -21,7 +42,6 @@ We're using [Onther-Tech/go-ethereum](https://github.com/Onther-Tech/go-ethereum For the simple start of both clients(ethereum, plasma-evm), you can run `run.rootchain.sh` in [Onther-Tech/go-ethereum](https://github.com/Onther-Tech/go-ethereum) and `run.pls.sh` in [Onther-Tech/plasma-evm](https://github.com/Onther-Tech/plasma-evm) (this is recommended way to setup devlop and test plasma-evm). - ## Build Just run `make geth` in terminal. @@ -46,12 +66,14 @@ DEVELOPER CHAIN OPTIONS: You can import your private key and HDwallet into new account with keystore #### Using Private Key + Inside `build/bin` directory, run the following command ```bash geth account importKey ``` #### Using HDwallet + Inside `build/bin` directory, run the following command ```bash geth account importHDwallet