From a761f3234fb50289310f706713075dcac73d2a7f Mon Sep 17 00:00:00 2001 From: yann300 Date: Tue, 13 Feb 2018 11:58:40 +0100 Subject: [PATCH] Update README.md --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 48 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eb574f9bf1..56f3c530e6 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,24 @@ Remixd needs `npm` and `node` ## HELP SECTION ``` - Usage: remixd -S + Usage: remixd -S - Provide a two ways connection between the local computer and Remix IDE + Provide a two ways connection between the local computer and Remix IDE. + Options: - -h, --help output usage information - -S, --shared-folder Folder to share with Remix IDE + -s, --shared-folder Folder to share with Remix IDE + -m, --mist start mist + -g, --geth start geth + -p, --dev-path Folder used by mist/geth to start the development instance + -f, --frontend Folder that should be served by remixd + -p, --frontend-port Http port used by the frontend (default 8082) + -a, --auto-mine mine pending transactions + -r, --rpc start rpc server. Values are CORS domain + -rp, --rpc-port rpc server port (default 8545) + -h, --help output usage information + ``` ## SHARE A FOLDER @@ -39,3 +49,37 @@ Furthermore : - It is not possible to create a file from `Remix IDE` (that might change). - If a folder does not contain any file, the folder will not be displayed in the explorer (that might change). - Symbolic links are not forwarded to Remix IDE. + +## START GETH, MIST and setup a developement environment + +Remix also allow to start a dev environment. +First note that `Mist` and `Geth` are not shipped with Remixd. +Download `Mist` at https://github.com/ethereum/mist/releases +Downloaf `Geth` at https://ethereum.github.io/go-ethereum/downloads + +Usage: + +`remixd --dev-path /home/devchains/chain1 --mist --geth --frontend /home/frontend --frontend-port 8084 --auto-mine` + + - start `geth`. + - start `mist`. + - create a new data folder (`dev-path` option) if it doesn't exist containing blockchain data and keys. + - serve a local folder through an http server (`frontend` and `frontend-port` option). + This option may be used if you want to browse your dapp using `Mist` or a normal browser and `Metamask` (see third example) (https://metamask.io). In this example the web application located at `/home/frontend` will be available at http://127.0.0.1:8084 + - start to mine automatically when new transactions are created. + +--- + + `remixd -s /home/user/project1/contracts` + + - allow accessing the local folder from Remix IDE (http://remix.ethereum.org) + +--- + + `remixd --dev-path /home/devchains/chain1 --rpc --rpc-port 8545 --geth --frontend /home/frontend --frontend-port 8084 --auto-mine` + +  - do the same as the first example but do not start `Mist`. + It is still possible to browse a front end app using a normal browser and Metamask. The connection between Metamask and `geth` has to be dome via rpc connection and thus the rpc server has to be enabled (`rpc` and `rpc-port` options). + +  Note that in that case Remix IDE (remix.ethereum.org) does not need Metamask. It is possible to use the `Web3 Provider` of Remix. +