From 3080cbad3c6c361b52e0b8bec894edf6b19a5376 Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Wed, 3 Feb 2021 14:22:57 +0530 Subject: [PATCH] root readme updated --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 2fb8a2ef69..a88ac23347 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # Remix Project -The Remix Project is a platform for development tools that use a plugin architecture. It encompasses sub-projects including Remix Plugin Engine, Remix Libraries, and of course Remix IDE. +**Remix Project** is a platform for development tools that use a plugin architecture. It encompasses sub-projects including Remix Plugin Engine, Remix Libraries, and of course Remix IDE. **Remix IDE** is an open source web and desktop application. It fosters a fast development cycle and has a rich set of plugins with intuitive GUIs. Remix is used for the **entire journey of contract development with [Solidity language](https://soliditylang.org/)** in as well as being a playground for learning and teaching Ethereum. @@ -23,7 +23,7 @@ The `master` branch has always the latest stable build of Remix. It also contain Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported. -## INSTALLATION: +## Setup Install **npm** and **node.js** (see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), then install [Nx CLI](https://nx.dev/react/cli/overview) globally to enable running **nx executable commands**. @@ -45,6 +45,11 @@ nx build remix-ide --with-deps nx serve ``` +Run `nx serve` and open `http://127.0.0.1:8080` in your browser. + +Then open your `text editor` and start developing. +The browser will automatically refresh when files are saved. + ## Docker: Prerequisites: @@ -79,21 +84,12 @@ Then go to http://localhost:8080 and you can use you Remix instance. To fetch docker-compose file without cloning this repo run: ``` -curl https://raw.githubusercontent.com/ethereum/remix-ide/master/docker-compose.yaml > docker-compose.yaml +curl https://raw.githubusercontent.com/ethereum/remix-project/master/docker-compose.yaml > docker-compose.yaml ``` -## DEVELOPING: - -Run `nx serve` and open `http://127.0.0.1:8080` in your browser. - -Then open your `text editor` and start developing. -The browser will automatically refresh when files are saved. - ### Troubleshooting building -Some things to consider if you have trouble building the package: - -- Make sure that you have the correct version of `node`, `npm` and `nvm`. Also ensure you have [Nx CLI](https://nx.dev/react/cli/overview) installed globally. You can find the version that is tested on Travis CI by looking at the log in the [build results](https://travis-ci.org/ethereum/remix-ide). +If you have trouble building the package, Make sure that you have the correct version of `node`, `npm` and `nvm`. Also ensure you have [Nx CLI](https://nx.dev/react/cli/overview) installed globally. Run: @@ -103,7 +99,7 @@ npm --version nvm --version ``` -- In Debian based OS such as Ubuntu 14.04LTS you may need to run `apt-get install build-essential`. After installing `build-essential` run `npm rebuild`. +In Debian based OS such as Ubuntu 14.04LTS you may need to run `apt-get install build-essential`. After installing `build-essential`, run `npm rebuild`. ## Unit Testing @@ -188,6 +184,9 @@ To run the Selenium tests via Nightwatch: **note that this token should have permission to create a gist.** -## Documentation +## Important Links -To see details about how to use Remix for developing and/or debugging Solidity contracts, please see [our documentation page](https://remix-ide.readthedocs.io/en/latest/) +Official documentation: https://remix-ide.readthedocs.io/en/latest/ +Curated list of Remix resources, tutorials etc.: https://github.com/ethereum/awesome-remix +Medium: https://medium.com/remix-ide +Twitter: https://twitter.com/ethereumremix