aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Voss <thomasvoss@live.com> 2022-01-14 20:29:44 +0100
committerThomas Voss <thomasvoss@live.com> 2022-01-14 20:29:44 +0100
commit005396c2d3d7f2b9254a783e72038b09581c23d6 (patch)
tree393d9dce01ec83932972234859ee53d173572726 /README.md
parent1d51b46a00966e6bd651d704146ec4311514f640 (diff)
Update the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 46 insertions, 2 deletions
diff --git a/README.md b/README.md
index efb8a37..16a90c4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
-# Draughts
-Draughts web game for CSE1500
+Draughts
+========
+
+This is an implementation of international draughts for CSE1300. It supports all of the following
+features:
+
+ - Multiple concurrent games via online multiplayer
+ - Resigning from a game
+ - Detection of users disconnections
+ - Forced piece captures (as per the official regulations)
+ - Piece capture deltas
+ - King pieces
+ - Viewable game history
+ - An incredibly simple and usable interface
+ - Far more comments than you have ever written
+
+The following features are missing (and probably won't get added due to time constraints):
+
+ - Detection of game draws
+ - Timers
+
+
+Setup
+-----
+
+To setup the draughts server for your own use, you need to run the following commands:
+
+```sh
+git clone "git@github.com:MayteSteeghs/draughts.git" # Clone the repository
+cd draughts/draughts # Navigate to the repo
+npm install # Install dependencies
+npm start # Start the server
+```
+
+By default the server will be serving locally on port 3000. If you want to configure this, you can
+figure out which parts of the code you need to change with the following command:
+
+```sh
+grep -R --exclude-dir=node_modules/ 3000
+```
+
+
+Authors
+-------
+
+Mayte Steeghs && Thomas Voss