aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index 83fefa6..db08a90 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# W.W.B.
+# W.W.B
A Rust simulation of the World's Worst Boardgame (W.W.B.) by Rich Hutnik.
@@ -64,19 +64,20 @@ where `savefile` is an optional argument that specifies the file to save the gam
Alternatively, you can use the following scripts to run the game:
-```sh
+```sh
./contrib/run-one
```
+
Builds and runs one instance of the game.
-```sh
+```sh
./contrib/run-in-parallel
```
+
Builds the program and runs one instance for every core on your machine.
These are sh scripts, Windows users will need to use WSL or a similar tool to run these scripts.
-
## License
-This project is licensed under the 0BSD license. See the [LICENSE](LICENSE) file for details. \ No newline at end of file
+This project is licensed under the 0BSD license. See the [LICENSE](LICENSE) file for details.