From: sabadev <saba@sabadev.xyz>
Date: Tue, 2 Feb 2021 04:12:44 +0000 (-0500)
Subject: Added installation instructions and the game description to the readme file.
X-Git-Url: http://sabadev.xyz:4321/?a=commitdiff_plain;h=6e20bda90781183ac31bf9c88bbf317f1007bfb7;p=avoidance.git

Added installation instructions and the game description to the readme file.
---

diff --git a/README.md b/README.md
index 5dcb696..a6fa2de 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,55 @@
-# avoidance
+# AVOIDANCE
+
+## Images
+
+![Title](title.png)
+
+![Help](help.png)
+
+![Game](game.png)
+
+## Compilation instructions
+
+* Install `stack` from https://docs.haskellstack.org/en/stable/README/#how-to-install
+* Run `stack build` in the root directory of the repository
+* Run `stack install` to copy the built executable to a location on your path
+
+## How to run the game
+
+Avoidance can be run from any ANSI terminal.
+The terminal must be at least 80 columns wide and 24 rows high to fit the game.
+If the terminal is too small, the game will print the following error:
+
+    Please resize your terminal and relaunch the game!
+
+To fix this issue, increase the terminal size and try to run Avoidance again.
+
+## How to play the game
+
+### Objective
+
+Push the box around the screen, making sure that it is not pushed off the edge.
+Box thieves will appear sporadically to steal the box.
+Your objective is to keep the box on-screen for as long as possible.
+
+Characters:
+
+* `P`: Player
+* `O`: Box
+* `X`: Box Thief
+
+### Controls
+
+#### Title screen
+
+* Start new game: `P`
+* Quit game: `Q`
+* Help screen: `H`
+
+### Game controls
+
+* Move up: `W`
+* Move down: `S`
+* Move left: `A`
+* Move right: `D`
+* Abort game: `Q`
diff --git a/game.png b/game.png
new file mode 100644
index 0000000..6bb3b71
Binary files /dev/null and b/game.png differ
diff --git a/help.png b/help.png
new file mode 100644
index 0000000..154e5d5
Binary files /dev/null and b/help.png differ
diff --git a/title.png b/title.png
new file mode 100644
index 0000000..f7c2a68
Binary files /dev/null and b/title.png differ