From 7d1b2c96780f2ffb08a97420fac2794a264c764d Mon Sep 17 00:00:00 2001
From: Steph Enders <smenders@gmail.com>
Date: Fri, 17 Jun 2022 12:30:38 -0400
Subject: Add readme and ignore build files

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7fde27a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# dng
+
+## Develop
+
+### Dependencies
+
+Current build process is setup for a *nix like environment.
+
+| Dependency | Version |
+| :---- |:--------|
+| c++   | 20+     |
+| g++   | 8+      |
+| CMake | 3.20+   |
+| Lua   | 5.4.*   |
+
+_Note: with some CMake modifications we could probably leverage lower versions_
+
+### Build
+
+dng uses CMake
+
+```shell
+# use a build dir to ensure we ignore build props
+cmake -B cmake-build
+```
+
+_Developed with CLion using CMake and g++ on Linux_
+
+## Run
+
+Once you build the project you can execute it by:
+
+```shell
+# use your build dir and select a map!
+./cmake-build/dng ./path/to/map/lvl
+```
+
+To launch level 1 for example:
+
+```shell
+./cmake-build/dng ./maps/lvl1
+```
+
+Note: You need to use the working directory containing the `include` folder!
-- 
cgit v1.2.3-54-g00ecf