Changelog

CHANGELOG.md

@@ -1,47 +1,53 @@
+## 2022-11-25
+* ICS and CalDav calendar support added by [anthonyscorrea](https://github.com/mendhak/waveshare-epaper-display/pull/43)
+* Moved pip package list into requirements.txt.  The package versions are fixed, it's simpler to install, and better stability.
+* Refactored the calendar code into providers and simplified the code for better reuse
+* Added instructions and VSCode integration for running and debugging the project locally
+
 ## 2022-10-04
-* Bugfix: an `&` ampersand in event title would cause image generation to crash. 
+* Bugfix: an `&` ampersand in event title would cause image generation to crash.
 
 ## 2022-04-21
-* By default, past calendar events will disappear from the list. 
+* By default, past calendar events will disappear from the list.
 * Added option to show all past events from today, `CALENDAR_INCLUDE_PAST_EVENTS_FOR_TODAY=1`
 
 ## 2022-04-13
 * Add new layouts for the user to choose from. Set the value `export SCREEN_LAYOUT=1` to 2, 3, 4...
-* Layouts contributed by @feh123 and @jmason 
-* Added the ability to have custom SVGs added onto the rendered output.  Done via `screen-custom-get.py` and `screen-custom.svg`.  
+* Layouts contributed by @feh123 and @jmason
+* Added the ability to have custom SVGs added onto the rendered output.  Done via `screen-custom-get.py` and `screen-custom.svg`.
 * Bugfix: Multi day events will now show start and end days. eg, "Monday - Wednesday"
 
 ## 2022-04-10
-* Use friendly day names for calendar entries, like "Today", "Tonight", "Tomorrow".  
-* If the calendar entry is within the next 6 days use the day name "Monday" "Tuesday", else use "Mon Apr 18". 
+* Use friendly day names for calendar entries, like "Today", "Tonight", "Tomorrow".
+* If the calendar entry is within the next 6 days use the day name "Monday" "Tuesday", else use "Mon Apr 18".
 
 ## 2022-04-08
 * Add Met Éireann weather and alert provider by [@jmason](https://github.com/mendhak/waveshare-epaper-display/pull/34)
 
 ## 2022-03-06
 * Add weather.gov as a weather and alert provider
 * Add VisualCrossing instructions to the README
-* Rename the weather and alert and calendar cache files to use a `cache_` prefix.  A little consistency. 
+* Rename the weather and alert and calendar cache files to use a `cache_` prefix.  A little consistency.
 
 ## 2022-01-07
 
 * Add cryptography==36.0.0 to setup. It's used by msal, but version 36.0.1 from piwheels produces [illegal instruction](https://github.com/piwheels/packages/issues/273)
-* Add gsfonts to setup.  It contains Nimbus fonts required by the SVG.  
+* Add gsfonts to setup.  It contains Nimbus fonts required by the SVG.
 
 ## 2021-12-29
 
-* Updated instructions for Raspberry Pi OS Bullseye.  Many dependencies stopped working, fixed it now. 
-* Removed some dependencies that aren't needed anymore! BCM not needed.  WiringPi is deprecated.  LibJpeg doesn't look needed.  
-* Replace Inkscape with CairoSVG. Inkscape broke some commandline args, and CairoSVG seems better suited for commandline anyway. 
-* Updated Google Calendar instructions, it's simpler for now, until Google break their URLs again. 
+* Updated instructions for Raspberry Pi OS Bullseye.  Many dependencies stopped working, fixed it now.
+* Removed some dependencies that aren't needed anymore! BCM not needed.  WiringPi is deprecated.  LibJpeg doesn't look needed.
+* Replace Inkscape with CairoSVG. Inkscape broke some commandline args, and CairoSVG seems better suited for commandline anyway.
+* Updated Google Calendar instructions, it's simpler for now, until Google break their URLs again.
 
 ## 2021-10-29
 
-* Bug fix - Outlook calendar entries will now show in local time, instead of UTC. 
+* Bug fix - Outlook calendar entries will now show in local time, instead of UTC.
 
 ## 2021-08-13
 
-* Calendar entries will include all events from today, even if they are past.   
+* Calendar entries will include all events from today, even if they are past.
 
 ## 2021-08-10
 
@@ -67,7 +73,7 @@
 
 ## Before all that
 
-* Basic weather, time and event dashboard.  
+* Basic weather, time and event dashboard.
 * There were a few weather providers hardcoded
 * There was PiHole stats but I removed it
 * There was TFL train times but I removed it

README.md

@@ -33,6 +33,7 @@ The screen will display date, time, weather icon with high and low, and calendar
 - [Adding custom data](#adding-custom-data)
 - [Troubleshooting](#troubleshooting)
 - [Waveshare documentation and sample code](#waveshare-documentation-and-sample-code)
+- [Debugging locally](#debugging-locally)
 
 
 ## Shopping list