From 60fcd8bee14fb8c42e00eae217a1218373c1f4a2 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Sun, 17 Sep 2023 22:42:08 +0200 Subject: [PATCH] README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..24aa2b9 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ + +# Kobo Calendar Server + +Small calendar web-server pulling from ICAL files, and presenting events in +a lightweight html frontend. + +The motivation was to create a lightweight wall calendar to use with an old Kobo +Aura e-reader, to take advantage of the it's e-ink screen. + +## Example usage + +1. Edit `config.py` to include links to your ICAL files. (Google Calendar hidden + ICAL links works great here.) +2. Launch server using something like: `python main.py --port 8082 --hostname 192.168.87.197` +3. Navigate to [192.168.87.197:8082](http://192.168.87.197:8082/). +4. Enjoy + + +