From a11529c2fc0472629e42700a983f38969306b466 Mon Sep 17 00:00:00 2001 From: mmk2410 Date: Sun, 13 Dec 2015 09:28:55 +0100 Subject: [PATCH] Updated Readme --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 46915f4..a831bd0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ #Mensplan -A python script for viewing the menu of the mensa at the university of ulm +A python script for viewing the menu of the canteens of the Studierendenwerk Ulm in Ulm. The supported canteens are: + - Mensa University + - CafeteriaB + - Southside Burgerbar + - Bistro + - Cafeteria West + - WestSideDiner + - Mensa Hochschule + +##Usage +After making the mensaplan.py executable with `chmod +x mensaplan.py` you have the following options: +``` +./mensaplan.py place +Print the todays menu at the place. + +./mensaplan.py place [mon, thu, wed, thur, fri] +Print the menu at the place of the given weekday. + +Supported places are: +Mensa University: mensa +Bistro: bistro +Burgerbar Southside: burgerbar +CafeteriaB: cafeteriab +Cafeteria West: west +West Side Diner: westside +Mensa Hochschule: hochschule +``` + + +## License + +MIT License