aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-12-18 11:52:24 -0600
committerMatt Strapp <matt@mattstrapp.net>2024-12-18 11:52:24 -0600
commit9633ddfe01f93e143d0c2ed6cc82be38cb9911a0 (patch)
treecf243f8b10a814cfd6c1aaf8bdafd6b629b6dc01
parentAdd exec flags (diff)
downloadwwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.tar
wwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.tar.gz
wwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.tar.bz2
wwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.tar.lz
wwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.tar.xz
wwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.tar.zst
wwb-9633ddfe01f93e143d0c2ed6cc82be38cb9911a0.zip
add README
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index bd8fceb..83fefa6 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,23 @@ To run the project, run:
where `savefile` is an optional argument that specifies the file to save the game state to. If no savefile is provided, the game will start from the beginning and **NOT SAVE**.
+#### Using the contrib file
+
+Alternatively, you can use the following scripts to run the game:
+
+```sh
+./contrib/run-one
+```
+Builds and runs one instance of the game.
+
+```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