mirror
/
remix-project
mirror of https://github.com/ethereum/remix-project.git
2
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md content

Browse Source
pull/837/head
Suriyaa Sundararuban 4 years ago committed by Aniket
parent 8514b58587
commit 4b03e9d9d3
1 changed files with 10 additions and 7 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 17
      README.md

17
README.md
Unescape View File

@ -4,36 +4,39 @@
# Remix # Remix
Remix is a browser-based compiler and IDE that enables users to build **Ethereum contracts with Solidity language** and to debug transactions. **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.
To try it out, visit [https://remix.ethereum.org](https://remix.ethereum.org). To try it out, visit [https://remix.ethereum.org](https://remix.ethereum.org).
https://github.com/ethereum/remix-project/releases also gives others ways to use Remix locally. Please check it out. The [release page](https://github.com/ethereum/remix-project/releases) also gives others ways to use Remix locally. Please check it out.
Remix consists of many modules and in this repository you will find Remix related apps, libs and plugins. (remix-ide, remix-analyzer, etc.). Remix consists of many modules and in this repository you will find Remix related apps, libs and plugins (remix-ide, remix-analyzer, etc.).
![Remix screenshot](https://github.com/ethereum/remix-project/raw/master/apps/remix-ide/remix_screenshot.png) ![Remix screenshot](https://github.com/ethereum/remix-project/raw/master/apps/remix-ide/remix_screenshot.png)
## Offline Usage ## Offline Usage
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. 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.
Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported. Note: It contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported.
## INSTALLATION: ## INSTALLATION:
Install **npm** and **node.js** (see https://docs.npmjs.com/getting-started/installing-node), then 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**. install [Nx CLI](https://nx.dev/react/cli/overview) globally to enable running **nx executable commands**.
```bash ```bash
npm install -g @nrwl/cli npm install -g @nrwl/cli
``` ```
clone the github repository (`wget` need to be installed first) : Clone the github repository (`wget` need to be installed first):
```bash ```bash
git clone https://github.com/ethereum/remix-project.git git clone https://github.com/ethereum/remix-project.git
```
And build it:
```bash
cd remix-project cd remix-project
npm install npm install
nx build remix-ide --with-deps nx build remix-ide --with-deps
@ -44,7 +47,7 @@ nx serve
Prerequisites: Prerequisites:
* Docker (https://docs.docker.com/desktop/) * Docker (https://docs.docker.com/desktop/)
* Docker-compose (https://docs.docker.com/compose/install/) * Docker Compose (https://docs.docker.com/compose/install/)
### Run with docker ### Run with docker

Write Preview
Loading…
Cancel
Save