diff --git a/README.md b/README.md index 4af0bc3..2014b45 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@
-A python3 software for displaying events (from iCalendars), weather (from openweathermap) and RSS feeds on selected E-Paper displays (4.2", 5.83", 7.5"(v1), 7.5"(v2)) from Waveshare/GoodDisplay. +A python 3 software for displaying events (from iCalendars), weather (from openweathermap) and RSS feeds on selected E-Paper displays (4.2", 5.83", 7.5"(v1), 7.5"(v2)) from Waveshare/GoodDisplay. Inkycal v2.0.0 BETA is a refactoring of the previous release. It aims to fix certain problems with the previous release, including but not limited to: @@ -28,7 +29,7 @@ Inkycal v2.0.0 BETA is a refactoring of the previous release. It aims to fix cer * [x] Allow using on windows (no-render mode) * [x] Implement features from dev branch * [x] Make it easier for developers (and beginners) to create their own custom module -* [ ] Implement testing for each module +* [x] Implement testing for each module * [ ] Add support for 9.7" ePaper * [ ] Add support for iCalendars requiring authentification * [ ] Add module for TODOIST api @@ -66,21 +67,36 @@ You can alternatively also open `settings-UI.html` in your web-browser. from inkycal import Inkycal # tell the Inkycal class where your settings file is -ink = Inkycal('/path/to/your/settings/file', render = True) +inky = Inkycal('/path/to/your/settings/file', render = True) # render means rendering (showing) on the ePaper. Setting render = False will not show anything on the ePaper # test if Inkycal can be run correctly, running this will show a bit of info for each module -ink.test() +inky.test() # If there were no issues, you can run Inkycal nonstop: -ink.run() +inky.run() ``` +### Customizing +With this release, it has become much easier to customize the modules to suit your preferences. First, check what options can be configured for a specific module: + +```python +# Module refers to the name of a module's Class, e.g. Agenda, RSS, Calendar ... +inky.Module.set(help=True) # shows configurable options + +# Set a single option +inky.Module.set(fontsize=14) + +# Set multiple options at once +inky.Module.set(fontsize=14, language='de') +``` + + ## Known issues (will be fixed before the production release) -* [ ] Inkycal-image is not yet supported +* [x] ~~Inkycal-image is not yet supported~~ * [ ] Inkycal-server is not yet supported -> depends on inkycal-image * [ ] Calibration is not yet implemented automatically. For now, only manual calibration is supported: `ink.calibrate()` -* [ ] Fix: `AttributeError` in `Layout` module for non-colour epaper displays +* [x] ~~Fix: `AttributeError` in `Layout` module for non-colour epaper displays~~ * [ ] Improvement: Change the way the web-ui handles ical-urls ## Updating BETA to latest version @@ -160,3 +176,11 @@ In order to speed up development, most development tasks (apart from the actual ## Contact * Email: aceisace63@yahoo.com (average response time < 24 hours) * Discord: [Inky-Calendar chatroom](https://discord.gg/sHYKeSM) + +## Buy me a coffee +Yes please :). I do drink and like my coffee, especially when developing the inkycal software :) +You can donate a coffee with this QR-code (Paypal): + +
+
+