Skip to content

Commit 3080cba

Browse files
committed
root readme updated
1 parent 55d2a15 commit 3080cba

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Remix Project
66

7-
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.
7+
**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.
88

99
**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.
1010

@@ -23,7 +23,7 @@ The `master` branch has always the latest stable build of Remix. It also contain
2323
Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported.
2424

2525

26-
## INSTALLATION:
26+
## Setup
2727

2828
Install **npm** and **node.js** (see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), then
2929
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
4545
nx serve
4646
```
4747

48+
Run `nx serve` and open `http://127.0.0.1:8080` in your browser.
49+
50+
Then open your `text editor` and start developing.
51+
The browser will automatically refresh when files are saved.
52+
4853
## Docker:
4954

5055
Prerequisites:
@@ -79,21 +84,12 @@ Then go to http://localhost:8080 and you can use you Remix instance.
7984

8085
To fetch docker-compose file without cloning this repo run:
8186
```
82-
curl https://raw.githubusercontent.com/ethereum/remix-ide/master/docker-compose.yaml > docker-compose.yaml
87+
curl https://raw.githubusercontent.com/ethereum/remix-project/master/docker-compose.yaml > docker-compose.yaml
8388
```
8489

85-
## DEVELOPING:
86-
87-
Run `nx serve` and open `http://127.0.0.1:8080` in your browser.
88-
89-
Then open your `text editor` and start developing.
90-
The browser will automatically refresh when files are saved.
91-
9290
### Troubleshooting building
9391

94-
Some things to consider if you have trouble building the package:
95-
96-
- 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).
92+
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.
9793

9894
Run:
9995

@@ -103,7 +99,7 @@ npm --version
10399
nvm --version
104100
```
105101

106-
- 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`.
102+
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`.
107103

108104
## Unit Testing
109105

@@ -188,6 +184,9 @@ To run the Selenium tests via Nightwatch:
188184
**note that this token should have permission to create a gist.**
189185

190186

191-
## Documentation
187+
## Important Links
192188

193-
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/)
189+
Official documentation: https://remix-ide.readthedocs.io/en/latest/
190+
Curated list of Remix resources, tutorials etc.: https://github.com/ethereum/awesome-remix
191+
Medium: https://medium.com/remix-ide
192+
Twitter: https://twitter.com/ethereumremix

0 commit comments

Comments
 (0)