aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..aa0bae8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,15 @@
+# dmtool
+
+dmtool is a library to manipulate D&D monsters
+
+Dependencies:
+
+ * nlohmann-json (for parsing the data files)
+ * libconfuse (for parsing the configuration file)
+
+## Compiling and Installing
+
+```console
+make
+sudo make install
+```