bernardo/nocal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README for 0.1 features and CalDAV support

Browse Source
This commit is contained in:
Bernardo Magri
2026-07-23 20:07:59 +01:00
parent 1a69950f93
commit d2191094b8
1 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -4,12 +4,12 @@ Nocal is a fast, local-first C++20 month calendar designed for the Linux
terminal and Hyprland. It presents appointments inside a six-week month grid and terminal and Hyprland. It presents appointments inside a six-week month grid and
inherits its colors from your terminal theme. inherits its colors from your terminal theme.
This repository currently contains the first local-calendar vertical slice: This repository contains a complete local calendar with guarded atomic
date/domain logic, guarded atomic iCalendar persistence, add/edit/delete forms, iCalendar persistence, recurrence rule editing, recurrence-ID overrides,
a responsive ANSI terminal UI with month and agenda views, explicit safe embedded VTIMEZONE round-trip, and Unicode display-width handling.
calendar import/export, tests, and Linux launch integration. A provider-neutral Remote synchronization is supported for Microsoft 365 (Office 365) and
SQLite cache now provides the durable boundary required before CalDAV servers (Nextcloud, iCloud, Radicale, etc.). Google Calendar support
Office 365 or any other remote provider is connected. See is planned. See
[the product specification](docs/PRODUCT.md), [the product specification](docs/PRODUCT.md),
[architecture](docs/ARCHITECTURE.md), and [roadmap](docs/ROADMAP.md). [architecture](docs/ARCHITECTURE.md), and [roadmap](docs/ROADMAP.md).
@@ -27,14 +27,15 @@ the month selection. Press `c` to open the calendar picker; arrows or
`j`/`k` select a calendar and `Enter` toggles its in-session visibility. Press `j`/`k` select a calendar and `Enter` toggles its in-session visibility. Press
`a` to add an appointment. Focus an `a` to add an appointment. Focus an
appointment and press `e` to edit it or `d` to delete it. Forms use `Tab` and appointment and press `e` to edit it or `d` to delete it. Forms use `Tab` and
`Shift-Tab` (or arrows) between fields, `Space` for the all-day toggle, `Shift-Tab` (or arrows) between fields, `Space` for the all-day toggle and
`Ctrl-S` to save, and `Esc` to cancel. Back in the calendar, `u` undoes the recurrence frequency cycling, `Ctrl-S` to save, and `Esc` to cancel. Back in
last successful mutation and `Ctrl-R` redoes it. Press `/` to search titles, the calendar, `u` undoes the last successful mutation and `Ctrl-R` redoes it.
descriptions, locations, and calendar IDs. Search results use arrows or Press `/` to search titles, descriptions, locations, and calendar IDs. Search
`j`/`k`; `Enter` jumps to the exact occurrence and `Esc` returns to the month. results use arrows or `j`/`k`; `Enter` jumps to the exact occurrence and `Esc`
The calendar picker and search are also available over the agenda with `c` and returns to the month. The calendar picker and search are also available over
`/`. Add, edit, and delete remain month-view workflows. the agenda with `c` and `/`. Add, edit, and delete remain month-view workflows.
Press `?` for help and `q` to quit. Press `L` for a screen-reader-friendly linear view. Press `?` for help and
`q` to quit.
## Build and run ## Build and run