aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGav Wood <i@gavwood.com>2015-01-12 00:54:36 +0800
committerGav Wood <i@gavwood.com>2015-01-12 00:54:36 +0800
commitded221fba2cc21e1037a1130d9d142e657a52e89 (patch)
tree48d0c2871eafec7049d0f5c04b24db8d0f91df3f /README.md
parent47687cf085196e2e4fa7ec42ff426f241dae10c5 (diff)
downloadgo-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.tar
go-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.tar.gz
go-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.tar.bz2
go-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.tar.lz
go-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.tar.xz
go-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.tar.zst
go-tangerine-ded221fba2cc21e1037a1130d9d142e657a52e89.zip
Merge commit 'ab745d3b0eb89d67db1ed953020c665be3d072ed' into develop
Conflicts: libjsqrc/ethereumjs/.travis.yml libjsqrc/ethereumjs/README.md libjsqrc/ethereumjs/dist/ethereum.js libjsqrc/ethereumjs/dist/ethereum.js.map libjsqrc/ethereumjs/lib/abi.js libjsqrc/ethereumjs/package.json
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/README.md b/README.md
index 865b62c6b..f18d382bd 100644
--- a/README.md
+++ b/README.md
@@ -50,13 +50,35 @@ web3.eth.coinbase.then(function(result){
For another example see `example/index.html`.
+## Contribute!
+
+### Requirements
+
+* Node.js
+* npm
+* gulp (build)
+* mocha (tests)
+
+```bash
+sudo apt-get update
+sudo apt-get install nodejs
+sudo apt-get install npm
+sudo apt-get install nodejs-legacy
+```
+
## Building
-* `gulp build`
+```bash (gulp)
+npm run-script build
+```
### Testing
+```bash (mocha)
+npm test
+```
+
**Please note this repo is in it's early stage.**
If you'd like to run a WebSocket ethereum node check out
@@ -76,4 +98,4 @@ ethereum -ws -loglevel=4
[dep-image]: https://david-dm.org/ethereum/ethereum.js.svg
[dep-url]: https://david-dm.org/ethereum/ethereum.js
[dep-dev-image]: https://david-dm.org/ethereum/ethereum.js/dev-status.svg
-[dep-dev-url]: https://david-dm.org/ethereum/ethereum.js#info=devDependencies \ No newline at end of file
+[dep-dev-url]: https://david-dm.org/ethereum/ethereum.js#info=devDependencies