From f9441c46416e2ff6d58ce9df320fa8cc9f2bcf90 Mon Sep 17 00:00:00 2001 From: cflip Date: Sun, 27 Feb 2022 15:12:39 -0700 Subject: Add build instructions to README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'README.md') 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. -- cgit v1.2.3