Merge pull request #234 from colkito/bug/fix-readme

Update README.md
This commit is contained in:
Manuel Aráoz 2014-02-11 15:35:51 -02:00
commit 5868d5af0e
1 changed files with 20 additions and 20 deletions

View File

@ -11,7 +11,14 @@ front-end and LevelDB for storage.
You can also follow [this gist](https://gist.github.com/isaacs/579814) You can also follow [this gist](https://gist.github.com/isaacs/579814)
for a quick and easy way to install Node.js and npm. If you use Ubuntu: for a quick and easy way to install Node.js and npm. If you use Ubuntu:
```git clone git@github.com:joyent/node.git && cd node && git checkout v0.10.24 && ./configure && make && make install``` ```
git clone git@github.com:joyent/node.git
cd node
git checkout v0.10.24
./configure
make
make install
```
* Bitcoind - Download and Install [Bitcoin](http://bitcoin.org/en/download) * Bitcoind - Download and Install [Bitcoin](http://bitcoin.org/en/download)
- You should make sure to configure RPC security and `txindex`. - You should make sure to configure RPC security and `txindex`.
@ -22,7 +29,6 @@ bitcoin directory (usually ~/.bitcoin).
### Tools ### Tools
* NPM - Node.js package manager, should be installed when you install node.js. * NPM - Node.js package manager, should be installed when you install node.js.
```
## Quick Install ## Quick Install
To install Insight, clone the main repository: To install Insight, clone the main repository:
@ -60,12 +66,10 @@ If you need to configure bitcoind server access set the following environment va
INSIGHT_NETWORK [= 'livenet' | 'testnet'] INSIGHT_NETWORK [= 'livenet' | 'testnet']
``` ```
Make sure that bitcoind is configured to accept incomming connections using 'rpcallowip' decribed in https://en.bitcoin.it/wiki/Running_Bitcoin. Alternatively change config/env/$NODE_ENV.js Make sure that bitcoind is configured to accept incomming connections using 'rpcallowip' decribed in https://en.bitcoin.it/wiki/Running_Bitcoin. Alternatively change `config/env/$NODE_ENV.js`
In case the network is changed, levelDB database need to be deleted. This can be performed running: In case the network is changed, levelDB database need to be deleted. This can be performed running:
``` ```util/sync.js -D```
util/sync.js -D
```
and waiting to Insight to synchronize again. The process can be interrupted and continued from the synchronization process embedded in main app insight.js safely. and waiting to Insight to synchronize again. The process can be interrupted and continued from the synchronization process embedded in main app insight.js safely.
@ -91,14 +95,10 @@ To run insight locally for development:
## Other utilities for development ## Other utilities for development
To compile and minify the web application's assets: To compile and minify the web application's assets:
``` ```grunt compile```
grunt compile
```
To run the tests To run the tests
``` ```grunt test```
grunt test
```
### Production ### Production