You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
# Remix Project
6
6
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.
8
8
9
9
**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.
10
10
@@ -23,7 +23,7 @@ The `master` branch has always the latest stable build of Remix. It also contain
23
23
Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported.
24
24
25
25
26
-
## INSTALLATION:
26
+
## Setup
27
27
28
28
Install **npm** and **node.js** (see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), then
29
29
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
45
45
nx serve
46
46
```
47
47
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
+
48
53
## Docker:
49
54
50
55
Prerequisites:
@@ -79,21 +84,12 @@ Then go to http://localhost:8080 and you can use you Remix instance.
79
84
80
85
To fetch docker-compose file without cloning this repo run:
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
-
92
90
### Troubleshooting building
93
91
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.
97
93
98
94
Run:
99
95
@@ -103,7 +99,7 @@ npm --version
103
99
nvm --version
104
100
```
105
101
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`.
107
103
108
104
## Unit Testing
109
105
@@ -188,6 +184,9 @@ To run the Selenium tests via Nightwatch:
188
184
**note that this token should have permission to create a gist.**
189
185
190
186
191
-
## Documentation
187
+
## Important Links
192
188
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
0 commit comments