aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorYour Name <you@example.com>2021-05-09 19:01:59 -0400
committerYour Name <you@example.com>2021-05-09 19:01:59 -0400
commite044fc4255aa64ef1dbc3d20ed87ed6e2f61a6bd (patch)
tree344c09421c5839a764a132fe9166f0e6e3f90e45 /readme.md
parentd13358b71ec15085f2638fd9c3fc634df62dfc94 (diff)
downloaddmtool-e044fc4255aa64ef1dbc3d20ed87ed6e2f61a6bd.tar.gz
dmtool-e044fc4255aa64ef1dbc3d20ed87ed6e2f61a6bd.tar.bz2
dmtool-e044fc4255aa64ef1dbc3d20ed87ed6e2f61a6bd.zip
Code refactoring
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
+```