From faafc1d5a4c0e9b2cd5f29353fcf1c8e1f3ba7dd Mon Sep 17 00:00:00 2001 From: Fabrizio Iannetti Date: Sat, 16 Sep 2023 16:27:43 +0200 Subject: [PATCH] doc: write README Signed-off-by: Fabrizio Iannetti --- README.adoc | 0 README.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/README.md b/README.md new file mode 100644 index 0000000..86bb7ac --- /dev/null +++ b/README.md @@ -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.