Update readme

pull/1/head
ninabreznik 7 years ago
parent af15ec597f
commit cf6c79ad43
  1. 64
      README.md

@ -2,63 +2,70 @@
# Remix
Remix (aka. Browser-Solidity) is a browser-based Solidity compiler and IDE.
Remix is a browser-based compiler and IDE that enables users to build **Ethereum contracts with Solidity language** and to debug transactions.
Visit [https://remix.ethereum.org](https://remix.ethereum.org) to use;
it will always deliver the latest version.
To try it out, visit [https://remix.ethereum.org](https://remix.ethereum.org).
Remix consists of many modules and in this repository you will find the Remix IDE (aka. Browser-Solidity).
![Remix screenshot](https://i.imgur.com/clfc7US.png)
## Offline Usage
The `gh-pages` branch always has the latest stable build of Remix. It also contains a ZIP file with the entire build. Download it to use offline.
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.
Note: it contains the latest release of Solidity available at the time of the packaging. No other compiler versions are supported.
## INSTALLATION:
Install npm and node.js (see https://docs.npmjs.com/getting-started/installing-node), then do:
Install **npm** and **node.js** (see https://docs.npmjs.com/getting-started/installing-node), then do:
* `git clone https://github.com/ethereum/browser-solidity`
* `cd browser-solidity`
* `npm install` - fetch dependencies & executes `npm run prepublish` to build the application
```bash
git clone https://github.com/ethereum/browser-solidity.git
cd browser-solidity
npm install
```
## DEVELOPING:
Run `npm start` 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
It is also possible to run `npm run build && npm run serve` but the web application will not automatically refresh.
The browser will automatically refresh when files are saved.
Most of the the time, working with the remix repository is not necessary.
But in case changes have to be made in remix too, the following command links remix to you local dev repository:
Most of the the time working with other modules (like debugger etc.) hosted in the [Remix repository](https://github.com/ethereum/remix) is not needed.
But in case changes have to be made in that repository too, the following command will help you link Remix with your local Browser-solidity repository:
after `npm install`
After `npm install` run also:
`npm run pullremix`
```bash
npm run pullremix
`npm run linkremixcore`
npm run linkremixcore
`npm run linkremixlib`
npm run linkremixlib
`npm run linkremixsolidity`
npm run linkremixsolidity
`npm run linkremixdebugger`
npm run linkremixdebugger
```
### Troubleshooting building
Here are some things to consider if you have trouble building the package.
Some things to consider if you have trouble building the package:
- Make sure that you have the correct version of `node`, `npm` and `nvm`. 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/browser-solidity).
Run:
node --version
npm --version
nvm --version
```bash
node --version
npm --version
nvm --version
```
- In Debian based OSes 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
@ -68,7 +75,7 @@ The tests are written using [tape](https://www.npmjs.com/package/tape).
Run the unit tests via: `npm test`
For local headless browser tests run `npm run test-browser`
(Requires selenium to be installed - can be done with `npm run selenium-install`)
(requires Selenium to be installed - can be done with `npm run selenium-install`)
Running unit tests via `npm test` requires at least node v7.0.0
@ -76,12 +83,13 @@ Running unit tests via `npm test` requires at least node v7.0.0
To run the Selenium tests via Nightwatch serve the app through a local web server:
npm run serve # starts web server at localhost:8080
`npm run serve` # starts web server at localhost:8080
Then you will need to either:
1. Have a Selenium server running locally on port 4444.
- Run: `npm run test-browser`
2. Or, install and run SauceConnect.
- Run: `sc -u <USERNAME> -k <ACCESS_KEY>` (see `.travis.yml` for values)
- Run: `npm run browser-test-sc`
@ -95,3 +103,7 @@ After that, follow these steps:
- Make sure 'Developer mode' has been checked
- Click 'Load unpacked extension...' to pop up a file-selection dialog
- Select your `browser-solidity` folder
## Documentation
To see details about how to use Remix for developing and/or debugging Solidity contracts, please see [our documentation page]().

Loading…
Cancel
Save