tupdate readme - canteen-info - scrape weekly menus from canteens surrounding Aarhus University
(HTM) git clone git://src.adamsgaard.dk/canteen-info
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit c807b8253785b32a155b6fd0b45592b8e4267e2b
(DIR) parent 2a256b04ed632faf97cf1003f4f9b8aa14c97ea2
(HTM) Author: Anders Damsgaard <anders.damsgaard@geo.au.dk>
Date: Thu, 19 Feb 2015 12:42:57 +0100
update readme
Diffstat:
M README.md | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
---
(DIR) diff --git a/README.md b/README.md
t@@ -1,2 +1,28 @@
# canteen-info
-Fetch and parse homepages from nearby canteens and display the weekly menu
+Fetch and parse homepages from nearby canteens and display the weekly menu. Up
+to date output can be found on
+[cs.au.dk/~adc/files/canteeninfo.html](https://cs.au.dk/~adc/files/canteeninfo.html).
+
+All content is licensed by the GNU Public License v.3 or later. See `LICENSE`
+for details.
+
+The package requires standard POSIX tools included in most modern Linux
+distributions, as well as `wget` and `html2text`.
+
+To install run:
+
+ $ sudo make install
+
+To generate the output HTML webpage run:
+
+ $ bash canteeninfo.sh
+
+The HTML file will be saved as `/tmp/canteeninfo.html`. I recommend copying the
+file to the www root folder if the machine hosts a webserver or transfering the
+file to a webserver using SCP. It is also recommended to automatically
+regenerate the page with a cron job, (``crontab -e``). For example:
+
+ 30 * * * * bash ~/code/canteen-info/canteeninfo.sh && scp /tmp/canteeninfo.html adc@fh.cs.au.dk:~/public_html_cs/files > ~/.canteeninfo.log
+
+Author: [Anders Damsgaard](mailto:andersd@riseup.net), maintained on
+[Github](https://github.com/anders-dc/canteen-info).