From d55b8f81e6caf23648d4b82b67c1d9d094aba000 Mon Sep 17 00:00:00 2001 From: Ben Ashton Date: Fri, 27 May 2022 06:14:58 -0700 Subject: [PATCH] Added README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c668003 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# SafetyVantage Coding Challenge + +A ranking system for the Snakes & Ladders championship. + +## Build + +Run the following commands to clone the repository and build the project + +```bash +git clone ssh://git@git.n0m.org:24/n0m/Snakes-And-Ladders.git +cd Snakes-And-Ladders +npm install +npm run build +``` + +## Usage + +To run the project with the provided sample data, use the following command + +```bash +npm run sample +``` + +The project also accepts a number of command line options for using your own game boards, game logs and game configurations. Usage is as follows: + +```bash +Usage: npm start -- boardFile gameLogFile [options] + options: + -h --help Print this message + -m --maxPlayersPerGame Maximum players per game + -d --debug Print stack trace on error +``` + +## Authors + +- [Ben Ashton](https://git.n0m.org/)