From a31cf66d9400059752a2c480bac132960383a8d9 Mon Sep 17 00:00:00 2001 From: historia Date: Fri, 16 Aug 2024 23:52:17 -0400 Subject: feat: parsing times to sort events works besides ugly edge cases --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1610fa6..f671f7b 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ In terms of features and complexity, Soon lies between [When](https://www.lighta # Quick Start -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. +1. Run `soon -e` to edit your default calendar. On first run, soon will generate a config and calendar file under $XDG_CONFIG_HOME/soon. -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. +2. Check the example calendar and add some events/todos. -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. +3. Run `soon` to see your agenda for the next 14 days. Run `soon -cm` to print a reference calendar and your agenda for the next month. 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. @@ -39,7 +39,7 @@ 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 +Mon-Fri 9am-5pm, Work all day # Uncommon recurrence patterns J%3, Every third day (See: Advanced Recurrence) @@ -130,7 +130,7 @@ May 1L Mon, Memorial Day (Last Monday of May) You can express times in 24h format or AM/PM format like this. Your agenda will be sorted by the start time of events. ``` -Fri 06:00, With no am/pm, 24h time is assumed +Fri 16:00, With no am/pm, 24h time is assumed Fri 12:00am, Midnight Fri 12pm, Noon @@ -166,9 +166,7 @@ Julian date modulus is weird, but it's a concise way to express multiple uncommo #### Footnote for astronomers and time nerds -The actual MJD is based on UTC, so Soon technically uses a *rounded*, modified Julian Day because it counts days since 1858-11-17 in your local time zone. This doesn't matter in practice. It's just a number that goes up by 1 every day. - -Soon's MJD is off by 1 from When. When starts counting from JD 1 while Soon more correctly starts counting from JD 0. +The actual MJD is based on UTC, so Soon technically uses a *rounded*, modified Julian Day because it counts days since 1858-11-17 in your local time zone. This doesn't matter in practice. It's just a number that goes up by 1 every day. Soon's MJD is off by 1 from When. When starts counting from JD 1 while Soon more correctly starts counting from JD 0. ## Todo List -- cgit v1.2.3