Added readme

1 files changed, 53 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..f04ddbc
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,53 @@
+
+## Sokoban
+
+A simple block pushing puzzle game Sokoban clone. This originally started out
+life as a university assignment written in Java. Then at some point years
+afterwards it seemed like a good idea to rewrite it in Ada using FLTK. I'm sure
+I had a good reason.
+
+
+
+#### Dependencies
+
+Build time:
+<ul>
+  <li>FLTKAda</li>
+  <li>gcc</li>
+  <li>GNAT</li>
+  <li>GPRbuild</li>
+</ul>
+
+Run time:
+<ul>
+  <li>FLTKAda</li>
+</ul>
+
+
+
+#### Building and Installation
+
+This repository is written to use the GNAT Project Manager build tools. To
+build, use the following command
+
+`gprbuild sokoban.gpr`
+
+There is a single build switch of `-Xbuild` which can have a value of `release`
+(the default) or `debug`.
+
+If you want to install this project, use
+
+`gprinstall -p -m sokoban.gpr`
+
+For further information on the build tools, consult the
+[GPRbuild docs](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug.html).
+
+
+
+#### Credits and Licensing
+
+Written by Jedidiah Barber.
+
+Licensed under the Sunset License v1.0. For details see `license.txt`.
+
+