1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b06dae2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# MPlusBuilder
+
+This repo provides a pipeline for building and packaging manaplus to an AppImage for use with 
+our [launcher](https://gitlab.com/TMW2/lawncable).
+
+**IMPORTANT:** The resulting appimage doesn't support relative paths in its arguments. SO ONLY USE **ABSOLUTE** PATHS.
+
+### Special Compilation Options
+
+```
+--enable-commandlinepassword
+```
+\ No newline at end of file