Commit 0bc4619a authored by Denton Liu's avatar Denton Liu

Reorganise README

parent 5399360b
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
# Browser-Solidity # Browser-Solidity
Browser Solidity is a browser-based Solidity compiler and IDE. Browser-Solidity is a browser-based Solidity compiler and IDE.
Visit [https://ethereum.github.io/browser-solidity](https://ethereum.github.io/browser-solidity) to use; Visit [https://ethereum.github.io/browser-solidity](https://ethereum.github.io/browser-solidity) to use;
it will always deliver the latest version. it will always deliver the latest version.
...@@ -10,7 +10,7 @@ it will always deliver the latest version. ...@@ -10,7 +10,7 @@ it will always deliver the latest version.
## Offline Usage ## Offline Usage
Full offline usage is currently not supported because the compiler is always Full offline usage is currently not supported because the compiler is always
loaded via http. If you clone/download the repository, use the loaded via HTTP. If you clone/download the repository, use the
`gh-pages` branch (otherwise you still have to build the application). `gh-pages` branch (otherwise you still have to build the application).
## Building ## Building
...@@ -24,45 +24,43 @@ Now point your browser to `index.html` to open the application. ...@@ -24,45 +24,43 @@ Now point your browser to `index.html` to open the application.
### Troubleshooting building ### Troubleshooting building
Here are some things to consider if you have trouble building the package. Here are 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). - 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: Run:
node --version
npm --version
nvm --version
node --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`.
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`.
## Unit Testing ## Unit Testing
Register new unit test files in `test/index.js`. The tests are written using [tape](https://www.npmjs.com/package/tape). Run the tests via: Register new unit test files in `test/index.js`. The tests are written using [tape](https://www.npmjs.com/package/tape). Run the tests via:
npm test npm test
## Browser Testing ## Browser Testing
To run the Selenium tests via nightwatch serve the app through a local web server: 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: Then you will need to either:
1. Have a Selenium server running locally on port 4444. 1. Have a Selenium server running locally on port 4444.
* Run: `npm run browser-test` - Run: `npm run browser-test`
1. Or, install and run SauceConnect. 2. Or, install and run SauceConnect.
* Run: `sc -u <USERNAME> -k <ACCESS_KEY>` (see .travis.yml for values) - Run: `sc -u <USERNAME> -k <ACCESS_KEY>` (see `.travis.yml` for values)
* Run: `npm run browser-test-sc` - Run: `npm run browser-test-sc`
## Usage as a Chrome Extension ## Usage as a Chrome Extension
If you would like to use this as a Chrome extension, you must either build it first or pull from the `gh-pages` branch, both described above. If you would like to use this as a Chrome extension, you must either build it first or pull from the `gh-pages` branch, both described above.
After that, follow these steps: After that, follow these steps:
* Browse to `chrome://extensions/` - Browse to `chrome://extensions/`
* Make sure 'Developer mode' has been checked - Make sure 'Developer mode' has been checked
* Click 'Load unpacked extension...' to pop up a file-selection dialog - Click 'Load unpacked extension...' to pop up a file-selection dialog
* Select your `browser-solidity` folder - Select your `browser-solidity` folder
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment