Added rudimentary readme

wgtools · May 14, 2018 · 8006557 · 8006557
1 parent 58dc66b
commit 8006557
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
-# putzplan
+# putzplan
+ A dead simple rust rocket app to host our cleaning plan.
+
+## Building
+Make sure you have a working rust toolchain, refer to the rocket docs.
+Run 'make' to build a Zip-file deployable to a server
+
+## Running
+Select your profile with 'ROCKET_ENV=production' and run the binary.