Clarify the readme a bit more

12urenloop · Nov 10, 2019 · 2192839 · 2192839
1 parent 85d96f1
commit 2192839
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/hw_sim/README.md b/hw_sim/README.md
@@ -1,22 +1,26 @@
 # Hardware simulation script
 
 ## Requirements
+Any versions of the below should work, but when in doubt, take the latest one
 
-Any* version of npm. Any* version of node.
+- `npm` 
+- `node`
 
 ## Setup
 
 `npm install`
 
 ## Run
 
-`node main.js`
+- First make sure an instance of telraam is running (see below how to specify the telraam address and port)
+
+- Then run: `node main.js`
 
 ## Arguments
 
 - `-h`: Show all the help messages.
-- `-p`: What port to connect to.
-- `-a`: What address to connect to.
+- `-p`: What port to connect to (default: `4564`)
+- `-a`: What address to connect to (default: `127.0.0.1`).
 - `-r`: The amount of runners to spawn.
 - `-b`: The amount of beacons to spawn.
 - `-m`: The average time per round