Skip to content

Commit 4b03e9d

Browse files
suriyaaAniket-Engg
authored andcommitted
Update README.md content
1 parent 8514b58 commit 4b03e9d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,39 @@
44

55
# Remix
66

7-
Remix is a browser-based compiler and IDE that enables users to build **Ethereum contracts with Solidity language** and to debug transactions.
7+
**Remix** is a browser-based compiler and IDE that enables users to build **Ethereum contracts with [Solidity language](https://soliditylang.org/)** and to debug transactions.
88

99
To try it out, visit [https://remix.ethereum.org](https://remix.ethereum.org).
1010

11-
https://github.com/ethereum/remix-project/releases also gives others ways to use Remix locally. Please check it out.
11+
The [release page](https://github.com/ethereum/remix-project/releases) also gives others ways to use Remix locally. Please check it out.
1212

13-
Remix consists of many modules and in this repository you will find Remix related apps, libs and plugins. (remix-ide, remix-analyzer, etc.).
13+
Remix consists of many modules and in this repository you will find Remix related apps, libs and plugins (remix-ide, remix-analyzer, etc.).
1414

1515
![Remix screenshot](https://github.com/ethereum/remix-project/raw/master/apps/remix-ide/remix_screenshot.png)
1616

1717
## Offline Usage
1818

19-
The `gh-pages` branch has always the latest stable build of Remix. It also contains a ZIP file with the entire build. Download it to use offline.
19+
The `master` branch has always the latest stable build of Remix. It also contains a ZIP file with the entire build. Download it to use offline.
2020

2121
Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported.
2222

2323

2424
## INSTALLATION:
2525

26-
Install **npm** and **node.js** (see https://docs.npmjs.com/getting-started/installing-node), then
26+
Install **npm** and **node.js** (see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), then
2727
install [Nx CLI](https://nx.dev/react/cli/overview) globally to enable running **nx executable commands**.
2828
```bash
2929
npm install -g @nrwl/cli
3030
```
3131

32-
clone the github repository (`wget` need to be installed first) :
32+
Clone the github repository (`wget` need to be installed first):
3333

3434
```bash
3535
git clone https://github.com/ethereum/remix-project.git
36+
```
3637

38+
And build it:
39+
```bash
3740
cd remix-project
3841
npm install
3942
nx build remix-ide --with-deps
@@ -44,7 +47,7 @@ nx serve
4447

4548
Prerequisites:
4649
* Docker (https://docs.docker.com/desktop/)
47-
* Docker-compose (https://docs.docker.com/compose/install/)
50+
* Docker Compose (https://docs.docker.com/compose/install/)
4851

4952
### Run with docker
5053

0 commit comments

Comments
 (0)