improve doc
This commit is contained in:
24
README.md
24
README.md
@@ -13,7 +13,8 @@ Instead, users are forced to install the buggy and heavy battery draining _MyMü
|
|||||||
So this tool aims to get rid of the app by parsing data from _MyMüll.de_ web service and synchronize the events with a conventional CalDAV server.
|
So this tool aims to get rid of the app by parsing data from _MyMüll.de_ web service and synchronize the events with a conventional CalDAV server.
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
* 1.0.0 - initial version
|
* 1.0.0
|
||||||
|
- first release with all basically needed functionality
|
||||||
|
|
||||||
## Implementation Status
|
## Implementation Status
|
||||||
- all required functionality implemented for basic usage
|
- all required functionality implemented for basic usage
|
||||||
@@ -35,6 +36,16 @@ So this tool aims to get rid of the app by parsing data from _MyMüll.de_ web se
|
|||||||
- export the CalDAV events to a local file for manual import to a calendar
|
- export the CalDAV events to a local file for manual import to a calendar
|
||||||
- unit tests for app
|
- unit tests for app
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
- install and setup latest python3 on your platform.
|
||||||
|
- open a shell and check if the command `python --version` works and points the intended version
|
||||||
|
- install it with via following shell command:
|
||||||
|
|
||||||
|
`python -m pip install https://github.com/Av3m/MyMuell2CalDAV/raw/master/releases/mymuell2caldav-1.0.0-py3-none-any.whl`
|
||||||
|
|
||||||
|
|
||||||
|
- start the tool via command `mymuell2caldav`
|
||||||
|
- alternatively, you could start with `python -m mymuell2caldav`
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
- get url of your CalDAV principal.
|
- get url of your CalDAV principal.
|
||||||
@@ -49,18 +60,7 @@ So this tool aims to get rid of the app by parsing data from _MyMüll.de_ web se
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||
## Setup
|
|
||||||
- install and setup latest python3 on your platform.
|
|
||||||
- open a shell and check if the command `python --version` works and points the intended version
|
|
||||||
- download the latest wheel package in subdirectory _releases/_ on this repository.
|
|
||||||
- install it with via following shell command:
|
|
||||||
(the string "x.x.x" need to be replaced with the latest version number)
|
|
||||||
|
|
||||||
`python -m pip install mymuell2caldav-x.x.x-py3-none-any.whl`
|
|
||||||
|
|
||||||
|
|
||||||
- start the tool via command `mymuell2caldav`
|
|
||||||
- alternatively, you could start with `python -m mymuell2caldav`
|
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
This tool was developed by an annoyed _MyMüll.de_ app user as a free contribution
|
This tool was developed by an annoyed _MyMüll.de_ app user as a free contribution
|
||||||
|
|||||||
Reference in New Issue
Block a user