Update readme to describe only the IDE part.

pull/1/head
chriseth 9 years ago
parent afb21fd02f
commit 95914e5bbc
  1. 52
      README.md

@ -1,51 +1,27 @@
# Browser-Solidity
#Browser-solidity
Browser solidity is a browser based solidity compiler and IDE.
Browser solidity is a browser based solidity compiler and IDE. To use either visit [https://chriseth.github.io/browser-solidity](https://chriseth.github.io/browser-solidity) or clone/download this repo and open `index.html` in your browser.
Visit [https://ethereum.github.io/browser-solidity](https://ethereum.github.io/browser-solidity) to use,
it will always deliver the latest version.
#Nodejs usage
# Offline Usage
To use the solidity compiler via nodejs you can install it via npm
Full offline usage is currently not supported because the compiler is always
loaded via http. If you clone or download the repository, you still have to
build it before you can use it.
npm install solc
# Building
And then use it like so:
Many dependencies are only provided via npm:
var solc = require('solc');
var input = "contract x { function g() {} }";
var output = solc.compile(input, 1); // 1 activates the optimiser
for (var contractName in output.contracts) {
// code and ABI that are needed by web3
console.log(contractName + ': ' + output.contracts[contractName].bytecode);
console.log(contractName + '; ' + JSON.parse( output.contracts[contractName].interface));
}
npm install # fetch dependencies
npm run build # build application into build/app.js
Starting from version 0.1.6, multiple files are supported with automatic import resolution by the compiler as follows:
Now point your browser to `index.html` to open the application.
var solc = require('solc');
var input = {
'lib.sol': 'library L { function f() returns (uint) { return 7; } }',
'cont.sol': 'import "lib.sol"; contract x { function g() { L.f(); } }'
};
var output = solc.compile({sources: input}, 1);
for (var contractName in output.contracts)
console.log(contractName + ': ' + output.contracts[contractName].bytecode);
# To use it as a chrome extension
Note that all input files that are imported have to be supplied, the compiler will not load any additional files on its own.
###Using a legacy version
In order to allow compiling contracts using a specific version of solidity, the `solc.useVersion` method is available. This returns a new solc object using the version provided. **Note**: version strings must match the version substring of the files availble in `/bin/soljson-*.js`. See below for an example.
var solc = require('solc');
// by default the latest version is used
// ie: solc.useVersion('latest')
// getting a legacy version
var solcV011 = solc.useVersion( 'v0.1.1-2015-08-04-6ff4cd6' );
var output = solcV011.compile( "contract t { function g() {} }", 1 );
#To use it as a chrome extension:
Browse to chrome://extensions/
Make sure 'Developer mode' has been checked. Then click 'Load unpacked extension...' to pop up a file-selection dialog.

Loading…
Cancel
Save