From 73ac90d7f5312d887ad76b154bfee7a496a83faa Mon Sep 17 00:00:00 2001
From: nsensfel <SpamShield0@noot-noot.org>
Date: Fri, 7 Sep 2018 13:19:00 +0200
Subject: Adds README.

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6947046
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Tacticians Online - Client
+This is the code for the front-end of Tacticians Online, an online
+multiplayer turn-based strategy game.
+
+## Getting Started
+
+### Prerequisites
+* Elm
+* GNU make
+* Tacticians Online - Data
+* m4
+
+### Installing
+1. Go into the directory in which this repository was cloned.
+2. Set the DATA\_DIR variable in `./Makefile` to match the "Tacticians Online -
+   Data" directory.
+3. Copy `./conf/constants.conf.example` to `./conf/constants.conf`, edit the new
+   file to your preference.
+4. Run `$ make`. Some Elm libraries will require confirmation before download.
+5. With a web browser, open the `./www/index.html` page. You're done.
+
+## Screenshot
+![Screenshot of a battle](https://noot-noot.org/to-2018-09-07.png)
+
+## License
+Apache License 2.0 (see `./LICENSE`)
-- 
cgit v1.2.3-70-g09d2