fianne/rs-calendar
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: write README

Browse Source 
Signed-off-by: Fabrizio Iannetti <fabrizio.iannetti@gmail.com>
This commit is contained in:
Fabrizio Iannetti 2023-09-16 16:27:43 +02:00
parent 977c3f4c02
commit faafc1d5a4
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
README.adoc
View File

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# A calendar viewer in written in rust
`calendar` is focused on displaying one or more files containing events in `ical` format
it is currently in an early development phase.
As a dependency, it requires the iced GUI repository to be cloned alongaside (see `Cargo.toml`)
## supported views:
* month view
* year view
## planned features
* read ical events from a list of calendar files given as arguments
* reload the events from a calendar file if the file changes
* there is currently no plan to connect to a system calendar (e.g. evolution) or remote.