summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcflip <cflip@cflip.net>2022-02-27 15:12:39 -0700
committercflip <cflip@cflip.net>2022-02-27 15:23:09 -0700
commitf9441c46416e2ff6d58ce9df320fa8cc9f2bcf90 (patch)
treec98fdd02f392b36888b60e98fa56330484c48db7 /README.md
parentacc2836e12b021283b95d4db4337f4413c304be2 (diff)
Add build instructions to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index fee0005..566fd1e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,13 @@
-# Nonortho \ No newline at end of file
+# Nonortho
+[Nonortho](https://cflip.net/projects/nonortho.html) is a WIP transport tycoon style isometric tile game.
+
+## Build Instructions
+First, clone the repository and use CMake to generate project files for your system.
+It is recommended that you create a ``build`` directory for CMake to generate build files into.
+```sh
+git clone https://github.com/cflip/Nonortho
+cd Nonortho
+mkdir build && cd build
+cmake ../
+```
+You can then use the generated project files to compile Nonortho.