improve doc
This commit is contained in:
parent
aa63622a93
commit
a82285ed3c
26
README.md
26
README.md
@ -12,8 +12,9 @@ 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.
|
||||
|
||||
##Changelog
|
||||
* 1.0.0 - initial version
|
||||
## Changelog
|
||||
* 1.0.0
|
||||
- first release with all basically needed functionality
|
||||
|
||||
## Implementation Status
|
||||
- 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
|
||||
- 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
|
||||
- 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
|
||||
This tool was developed by an annoyed _MyMüll.de_ app user as a free contribution
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user