From 9633ddfe01f93e143d0c2ed6cc82be38cb9911a0 Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Wed, 18 Dec 2024 11:52:24 -0600 Subject: add README Signed-off-by: Matt Strapp --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'README.md') 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 -- cgit v1.2.3