diff options
| -rw-r--r-- | README.md | 53 |
1 files changed, 33 insertions, 20 deletions
@@ -7,7 +7,7 @@ Soon is a minimalist, text file based, CLI calendar inspired by [When](https://w - Group, sort, comment, and columnize events to keep files neat - Add multiple lines of details to events - Archive events to remove them from your schedule (e.g. paid bill) -- Keep events on calendar until dismissed (e.g. missed oil change) +- Optionally keep events on calendar until dismissed (e.g. missed oil change) - Todo list with upcoming deadlines - Fun @@ -210,9 +210,29 @@ In soon.config, set `alwaysShowUnarchivedEvents=true` and old events will stick 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. +# Todo List + +Lines in .soon files that start with `-` will show up on the todo list. + +Lines starting with `+` are attached to the todo above it, similar to events. + +If you add a line with `+ Due:` followed by a date, it will show up separately from your events in a list of upcoming deadlines. + +``` +- Wash car +- Clean room +- Give book back to Sally + + Address: 555 Oak Street, Openville + +- Finish TPS report + + Due: Aug 7 2025 +``` + +If you delete an event in interactive mode, it will be deleted from the .soon file. + # Why would I use this? -Soon was created as alternative to [When](https://www.lightandmatter.com/when/when.html) with nicer syntax and todo features. It's for a small niche of people who mainly edit their schedule directly in a text file rather than a TUI. This group almost exclusively uses [Remind](https://dianne.skoll.ca/projects/remind/) or [Org Mode](https://orgmode.org). +Soon was created as alternative to [When](https://www.lightandmatter.com/when/when.html) with nicer syntax and a few extra todo/scheduling features. It's for a small niche of people who mainly edit their schedule directly in a text file rather than a TUI. This group almost exclusively uses [Remind](https://dianne.skoll.ca/projects/remind/) or [Org Mode](https://orgmode.org). Soon has a few benefits over similar text file calendars: @@ -222,31 +242,24 @@ Soon has a few benefits over similar text file calendars: **When**: `m=Jul & d>=1 & d<=7 & y=2025, Vacation!`\ **Remind**: `REM Jul 1 2025 THROUGH Jul 7 2025 MSG Vacation!` -2. Soon can use an archive file to manually "complete" events like todos +2. Soon can archive instances of events early -Take the event "Change air filter", scheduled every 6 months. I might see that upcoming and archive that instance a week early to remove it from my calendar. Or I might let it slide until next weekend, in which case it sticks around until it's manually archived. +Take the event "Pay quarterly bill", scheduled every 3 months. If I do that a week early, I can archive it so it's gone from my calendar. This won't affect other upcoming instances. -3. Soon can shows a todo list and upcoming deadlines. +3. Soon can keep events around until you archive them -# Alternatives +By setting `alwaysShowUnarchivedEvents=true`, Soon will keep every event on your calendar until you archive it. This mimics the behavior I used to have of keeping calendar reminders in my email inbox until they were done. -If you're interested in other text file calendars, I highly recommend When or Remind. It's easy to get caught up yak shaving the maximalist Emacs, so Org Mode has a very different vibe and I don't find it nearly as productive. +4. Soon can show a todo list and upcoming deadlines. + +# Alternatives - [When](https://www.lightandmatter.com/when/when.html) - The simplest text file calendar that's flexible enough for real world use. -- [Remind](https://dianne.skoll.ca/projects/remind/) - The most powerful, programmable calendar program ever made (CLI or otherwise) but simple cases are still concise. +- [Remind](https://dianne.skoll.ca/projects/remind/) - The most powerful, programmable calendar program ever made - [Better overview here.](https://blog.thechases.com/posts/remind/) -- [Org Mode](https://orgmode.org) - Expansive text productivity system, but a time sink trap for tinkerers. - -## See Also - -- [khal](https://github.com/pimutils/khal) - Similar CLI calendar, but stores calendars directly as .ics files. -- [calcure](https://github.com/anufrievroman/calcure) - The premier TUI calendar? -- [Calcurse](https://calcurse.org/) - The other big TUI calendar -- [Taskwarrior](https://taskwarrior.org/) - CLI todo thing with scheduling features -- [calendar.vim](https://github.com/itchyny/calendar.vim) - Vim plugin -- [Emacs Diary](https://www.gnu.org/software/emacs/manual/html_node/emacs/Format-of-Diary-File.html) - A single agenda/diary file. -- [Plain Text Personal Organizer](https://danlucraft.com/blog/2008/04/plain-text-organizer/) -- [Calendar.txt](https://terokarvinen.com/2021/calendar-txt/) - A one-day per line text calendar idea inspired by [todo.txt](https://todotxt.org/). +- [Org Mode](https://orgmode.org) - Expansive text file based productivity system but an endless time sink for tinkerers. + +You might also be interested in these which are text based but have somewhat different workflows: [khal](https://github.com/pimutils/khal), [calcure](https://github.com/anufrievroman/calcure), [Calcurse](https://calcurse.org/), [Taskwarrior](https://taskwarrior.org/), [calendar.vim](https://github.com/itchyny/calendar.vim), [Emacs Diary](https://www.gnu.org/software/emacs/manual/html_node/emacs/Format-of-Diary-File.html), [Plain Text Personal Organizer](https://danlucraft.com/blog/2008/04/plain-text-organizer/), [Calendar.txt](https://terokarvinen.com/2021/calendar-txt/) # Todo |