diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 14 insertions, 13 deletions
@@ -14,15 +14,13 @@ In terms of features and complexity, Soon lies between [When](https://www.lighta # Quick Start -1. Download Soon and copy it into you PATH (e.g. /usr/local/bin) +1. Run `soon -e`. This will generate a config and calendar file under $XDG_CONFIG_HOME/soon and open the calendar file in your editor. -2. Run `soon -e`. This will generate a config and calendar file under $XDG_CONFIG_HOME/soon and open the calendar file in your editor. +2. Check the example calendar and add some events/todos. You can just add `J%2, Hello World` for an event that repeats every other day if you want to quickly see how it looks. -3. Check the example calendar and add some events/todos. You can just add `J%2, Hello World` for an event that repeats every other day if you want to quickly see how it looks. +3. Run `soon` to see your agenda. With no options it will show you the next 14 days of events as well as your todos and deadlines. -4. Run `soon` to see your agenda. With no options it will show you the next 14 days of events as well as your todos and deadlines. - -5. 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 todos. Select events/todos with HJKL and archive them with Space. Esc to exit. # Example Calendar @@ -41,11 +39,17 @@ Fri !13, Every Friday except the 13th # Ranges (Jul 7 2024)-(Jul 13 2024), Shark Week July 7-13 2024, Shark Week +Mon-Fri 9am-5pm, What a way to make a living # Uncommon recurrence patterns J%3, Every third day (See: Advanced Recurrence) Fri 1W, First Friday of the month +# Add details to the above event with + +2025 Aug 1, Doctor's Appointment ++ Address: 123 Oak Street, Woodsville ++ Phone: +1 555-555-5555 + # Todos start with a hyphen - Buy milk - Read War and Peace @@ -147,7 +151,7 @@ Any line starting with a `+` is attached to the nearest above event. This can be ## Advanced Recurrence (Modified Julian Day `J%x+y`) -Soon supports using a Modified Julian Day as `J`. `J` is the number of full days since midnight November 17, 1858. This can be used along with the modulo operator `%` to create complex recurring events. +Soon supports using a Modified Julian Day as `J`. `J` is the number of full days since midnight November 17, 1858. Combined with the modulo operator `%` and an optional `+`/`-` offset this creates complex recurring events. This condition returns **true** when the result is 0 (This is the opposite of how When works). @@ -184,15 +188,12 @@ Attach a line with `+ Due: DATE` and it will show up in a list of upcoming deadl + Due: Aug 7 2025 ``` -You can delete finished todos from `then i` or just from your text editor. +You can delete finished todos from `soon i` or just from your text editor. # Archive File -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. +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. -- For recurring events with no end date, only the individual instance is archived. -- For events with one date, the event is removed from your calendar file. -- For events with an end date, it will only be removed from your calendar file if all occurences are archived. `showPastArchivedEvents` and `showFutureArchivedEvents` determine if archived events are hidden from your agenda entirely or show up as (Archived). @@ -216,7 +217,7 @@ Soon is a [When](https://www.lightandmatter.com/when/when.html) alternative with 3. You can optionally keep events on the agenda until manually archived. This mimics the behavior of keeping overdue calendar reminders in your email inbox. -4. Zero nonsense todos with upcoming deadlines. +4. Todos with upcoming deadlines and nothing else. It's just a list in a text file. # Alternatives |