summaryrefslogtreecommitdiff |
diff options
author | nsensfel <SpamShield0@noot-noot.org> | 2018-09-07 13:19:00 +0200 |
---|---|---|
committer | nsensfel <SpamShield0@noot-noot.org> | 2018-09-07 13:19:00 +0200 |
commit | 73ac90d7f5312d887ad76b154bfee7a496a83faa (patch) | |
tree | b3980ff11b275700d55a56708b5b8610e52e0194 | |
parent | d34375f7338a1397e8480e875baf5862138ed528 (diff) |
Adds README.
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
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 + + +## License +Apache License 2.0 (see `./LICENSE`) |