Skip to content

Commit 2ebd36d

Browse files
committed
README edits
1 parent c38fbb4 commit 2ebd36d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@ This repository serves as an example project that uses truebit-os as a dependenc
66

77
# Installation
88

9-
Make sure you already have `solc` installed and an Ethereum node on port 8545. You will also need browserify.
9+
You will need:
10+
11+
- `npm` installed
12+
- `solc` installed
13+
- An Ethereum node on port 8545 (`ganache-cli`)
14+
- `ipfs daemon` on port 5001
15+
- `browserify` installed
1016

1117
```
1218
npm i
@@ -19,7 +25,7 @@ browserify public/js/app.js -o public/js/bundle.js
1925

2026
# Usage
2127

22-
Start truebit-os in the background. You will also need to be running an ipfs daemon on port 5001
28+
In a separate terminal window start truebit-os in the background.
2329

2430
```
2531
cd truebit-os
@@ -31,7 +37,7 @@ This will start up the shell. We can start a solver on account 1 like so:
3137
start solve -a 1
3238
```
3339

34-
We need to deploy the Scrypt contract that the webapp will be interfacing with. We can do this by running:
40+
In a new terminal window, we need to deploy the Scrypt contract that the webapp will be interfacing with. We can do this by running:
3541

3642
```
3743
node deploy.js
@@ -46,9 +52,9 @@ node index.js
4652

4753
And navigate to `localhost:3000` in a MetaMask compatible browser.
4854

49-
Make sure to connect MetaMask to localhost:8545, and send the initial account some Ether so it can send transactions.
55+
Make sure to connect MetaMask to localhost:8545, and send the initial account some Ether so it can send transactions. The easiest way is to import the private key of an account in `ganache-cli` and then send some Ether to Account 1.
5056

51-
Once you send the transaction it will wait for the task to complete. The TrueBit task requires to periods of timeouts so you will need to use the skip command in the truebit-os shell.
57+
Once you enter some text, and press Submit. It will fire off a TrueBit task and wait for the task to complete. The TrueBit task requires two periods of timeouts so you will need to use the skip command in the truebit-os shell.
5258

5359
For best results (skip can be a bit finnicky):
5460
```
@@ -63,5 +69,5 @@ skip 300
6369
skip 300
6470
```
6571

66-
Task is finalized, and result should show up on the web page.
72+
Once the task is finalized the results should show up on the web page.
6773

0 commit comments

Comments
 (0)