iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ace 2020-06-19 18:15:36 +02:00 committed by GitHub
parent 9eea1f25a3
commit 88265fc8eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -41,6 +41,12 @@ If you were using the previous release, please re-run the instaler:
`bash -c "$(curl -sL https://raw.githubusercontent.com/aceisace/Inky-Calendar/master/Installer.sh)"` `bash -c "$(curl -sL https://raw.githubusercontent.com/aceisace/Inky-Calendar/master/Installer.sh)"`
and choose `uninstall` to uninstall the previous version. The last release and this BETA are __not__ compatible! and choose `uninstall` to uninstall the previous version. The last release and this BETA are __not__ compatible!
## Updating BETA to latest version
To update to the latest beta, please do the following:
1) `pip3 uninstall inkycal`
2) Remove the `Inkycal` folder (or rename it at least)
3) follow the steps from `Installation` (see above)
### Installation ### Installation
```bash ```bash
# clone this branch # clone this branch
@ -53,7 +59,7 @@ cd Inkycal
pip3 install -e ./ pip3 install -e ./
``` ```
### Creating settings file ### Creating a settings file
Please visit the [Online WEB-UI](http://aceinnolab.com/web-ui-v2-0-0-beta.html) to create your settings.json file. Please visit the [Online WEB-UI](http://aceinnolab.com/web-ui-v2-0-0-beta.html) to create your settings.json file.
You can alternatively also open `settings-UI.html` in your web-browser. You can alternatively also open `settings-UI.html` in your web-browser.
@ -95,16 +101,10 @@ inky.Module.set(fontsize=14, language='de')
## Known issues (will be fixed before the production release) ## Known issues (will be fixed before the production release)
* [x] ~~Inkycal-image is not yet supported~~ * [x] ~~Inkycal-image is not yet supported~~
* [ ] Inkycal-server is not yet supported -> depends on inkycal-image * [ ] 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()` * [x] ~~Calibration is not yet implemented automatically. For now, only manual calibration is supported: `ink.calibrate()`~~
* [x] ~~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 * [ ] Improvement: Change the way the web-ui handles ical-urls
## Updating BETA to latest version
To update to the latest beta, please do the following:
1) `pip3 uninstall inkycal`
2) Remove the `Inkycal` folder (or rename it at least)
3) follow the steps from `Installation` (see above)
## Main features ## Main features
* Monthly Calendar that shows events from your Google (or other) iCalendar/s * Monthly Calendar that shows events from your Google (or other) iCalendar/s
@ -113,10 +113,9 @@ To update to the latest beta, please do the following:
* RSS feeds from various providers to keep up to date with news, quotes etc. * RSS feeds from various providers to keep up to date with news, quotes etc.
## News: ## News:
* **Looking for a server-only solution? [This repo offers a server-only solution](https://github.com/Atrejoe/Inky-Calendar-Server) (Credit to Atrejoe)** * **[Server-only solution](https://github.com/Atrejoe/Inky-Calendar-Server) (Credit to Atrejoe)**
* **Discord chat open now. [Click here to enter](https://discord.gg/sHYKeSM)** * **Discord chat open now. [Click here to enter](https://discord.gg/sHYKeSM)**
* **Version 1.7.1 released with support for 4.2", 5.83", 7.5" (v1) and 7.5" (v2) E-Paper displays** (Mid January 2020) * **Added support for 4.2", 5.83", 7.5" (v1), 7.5" (v2) and 9.7" E-Paper displays**
* **Added support for Debian Buster, Buster Lite is not supported!**
## Development status ## Development status
This software is in active development. To see the current development status, [[Click here]](https://github.com/aceisace/Inky-Calendar/projects/2). This software is in active development. To see the current development status, [[Click here]](https://github.com/aceisace/Inky-Calendar/projects/2).