diff options
| author | historia <[not public]> | 2026-06-11 22:45:39 -0400 |
|---|---|---|
| committer | historia <[not public]> | 2026-06-11 22:45:39 -0400 |
| commit | 05d4fa5e4ccadc8521dc7bc3a2f4bc01ebafd40b (patch) | |
| tree | 5377c9d820165421e57c404d88393cb9b874258f | |
| parent | 75229ac7f76a7dbd1f9c0455535600ef0ee789a1 (diff) | |
| download | soon-05d4fa5e4ccadc8521dc7bc3a2f4bc01ebafd40b.tar.gz | |
readme
| -rw-r--r-- | README.md | 15 |
1 files changed, 12 insertions, 3 deletions
@@ -20,7 +20,9 @@ In terms of features and complexity, Soon lies between [When](https://www.lighta 3. Run `soon` to see your agenda for the next 14 days. Run `soon -cmtd` to print a reference calendar, next month's agenda, todos, and upcoming deadlines. -4. Run `soon -i` to start interactive mode and archive events or todos. Select events/todos with HJKL and archive them with Space. Esc to exit. +4. Run `soon -i` to start interactive mode and archive events or mark todos as done. Move with arrow keys or j/k. Toggle with Space, d, or x. Press Esc or q to quit. + +5. Run `soon -s` to edit your config file. Use `--config <path>` to point to an alternate config. # Example Calendar @@ -195,12 +197,20 @@ You can delete finished todos from `soon -i` or just from your text editor. You can archive events in interactive mode with `soon -i`. This lets you archive an event like "Pay rent" early so you know it's done. The default behavior is to delete the event from your calendar file when the last instance of the event is archived. +The archive file stores one entry per line. Event instances use `date|name` and completed todos use `- name`: + +``` +2025-07-04|Doctor's Appointment +- Buy milk +``` + +When you complete a todo in `soon -i`, it is removed from your `.soon` calendar file on quit. `showPastArchivedEvents` and `showFutureArchivedEvents` determine if archived events are hidden from your agenda entirely or show up as (Archived). #### Keep events on calendar until manually archived -In soon.config, set `alwaysShowUnarchivedEvents=true` and old events will stick on your calendar until archived (regardless of the `past` setting). This means you will have to manually acknowledge every event. +In `soon.conf`, set `alwaysShowUnarchivedEvents=true` and old events will stick on your calendar until archived (regardless of the `past` setting). This means you will have to manually acknowledge every event. Soon checks for events starting from `startDate` so you don't get recurring events showing up from the 1970s. Basically, everything before this date is considered archived. @@ -233,7 +243,6 @@ You might also be interested in these which are text based but have somewhat dif - Create tests for date ranges that start/end on DST changes. The condition checker treats every event as midnight, might be an edge case. - Julian modulus calculator (`soon -j Jun 5 2025` > Outputs J and a table of common mod offsets) -- TUI - CalDAV/.ics export? - Numerous CLI programs store calendars with .ics files directly, so it doesn't make much sense to use Soon if you need to sync to a "main" calendar. - Import? |
