From 8006557817978cb30fa04e9eb54ba6e13ae7e249 Mon Sep 17 00:00:00 2001 From: Marco Amann Date: Mon, 14 May 2018 12:46:31 +0200 Subject: [PATCH] Added rudimentary readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c5100c5..6479f47 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ -# putzplan \ No newline at end of file +# 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.