aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-12-18 11:53:40 -0600
committerMatt Strapp <matt@mattstrapp.net>2024-12-18 11:53:40 -0600
commit84036d757b14f5746d26e16692a3e4ac0e2b6430 (patch)
tree968b4e4dc64aca112e5491167bcd5f8c0daab556
parentadd README (diff)
downloadwwb-master.tar
wwb-master.tar.gz
wwb-master.tar.bz2
wwb-master.tar.lz
wwb-master.tar.xz
wwb-master.tar.zst
wwb-master.zip
make MDCHECK happyHEADmaster
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
-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.