Update README.md

pull/7/head
yann300 9 years ago committed by GitHub
parent 28acc214b4
commit a27ab6023f
  1. 39
      README.md

@ -1,7 +1,14 @@
# remix
# REMIX
Ethereum IDE and tools for the web
INSTALLATION:
## REMIX WEBSITE:
Remix is avalaible at https://ethereum.github.io/remix
You'll have to run your own node using the following parameters:
geth --rpc --rpcapi 'web3,eth,debug' --rpcport 8545 --rpccorsdomain '*'
geth will run the rpc server on http://localhost:8545, remix uses this url by default to connect to web3.
## INSTALLATION:
Brief instructions to build for linux(Todo add other platforms) we will add detailed instructions later
@ -13,21 +20,7 @@ Install eth or geth, npm and node.js (see https://docs.npmjs.com/getting-started
open remix/index.html in your browser.
CODING STYLE:
Remix uses npm coding style: https://docs.npmjs.com/misc/coding-style
Please be sure your code is compliant with this coding standard before sending PR.
There's on the above page a bunch of links that propose integration with developer tools (Emacs, Atom, ...).
You can also run 'npm run test' to check your local repository against the coding style.
REMIX WEBSITE:
Remix is avalaible at https://ethereum.github.io/remix
You'll have to run your own node using the following parameters:
geth --rpc --rpcapi 'web3,eth,debug' --rpcport 8545 --rpccorsdomain '*'
geth will run the rpc server on http://localhost:8545, remix uses this url by default to connect to web3.
REMIX First Step:
## REMIX First Step:
Once remix is connected to a node, you will be able to debug transactions.
There's two way of doing that:
@ -39,7 +32,7 @@ Then the vm trace is loaded.
The debugger itself contains several controls that allow stepping over the trace and seing the current state of a selected step.
- Slider and Stepping action:
#### Slider and Stepping action:
The slider allows to move quickly from a state to another.
Stepping actions are:
@ -49,7 +42,7 @@ Stepping actions are:
- Step Into Forward
- Jump Next Call (this will select the next state that refers to a context changes - CALL, CALLCODE, DELEGATECALL, CREATE)
- State Viewer:
#### State Viewer:
The upper right panel contains basic informations about the current step:
- VMTraceStep: the index in the trace of the current step.
@ -66,3 +59,11 @@ The other 6 panels describe the current selected state:
- Memory
- Call Data
- Call Stack
## CODING STYLE:
Remix uses npm coding style: https://docs.npmjs.com/misc/coding-style
Please be sure your code is compliant with this coding standard before sending PR.
There's on the above page a bunch of links that propose integration with developer tools (Emacs, Atom, ...).
You can also run 'npm run test' to check your local repository against the coding style.

Loading…
Cancel
Save