diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 14 insertions, 11 deletions
@@ -4,7 +4,7 @@ Soon is a minimalist, text file based, CLI calendar inspired by [When](https://w - Schedule events in a text file with concise syntax - Group, sort, comment, and columnize events to keep files neat -- Add multiple lines of details to events +- Add details to events - Archive events to remove them from your schedule (e.g. paid bill) - Optionally keep events on calendar until dismissed (e.g. missed oil change) - Todo list with upcoming deadlines @@ -18,7 +18,7 @@ In terms of features and complexity, Soon lies between [When](https://www.lighta 2. Check the example calendar and add some events/todos. -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. +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. @@ -59,11 +59,11 @@ Fri 1W, First Friday of the month # .soon file syntax -Each event is a line with date conditions followed by `,` and a description. +Each line is a series of date conditions followed by `,` and the event name Lines starting with `-` are todos -Lines starting with `+` are attached to the above event/todo to add details or deadlines. +Lines starting with `+` are attached to the above event/todo to add details or deadlines. I like indenting these but you don't have to. Lines starting with `#` are comments and ignored, as are blank lines. @@ -127,7 +127,7 @@ May 1L Mon, Memorial Day (Last Monday of May) ## Time -You can express times in 24h format or AM/PM format like this. Your agenda will be sorted by the start time of events. +You can express times in 24h format or AM/PM format. Your agenda will be sorted by the start time of events. ``` Fri 16:00, With no am/pm, 24h time is assumed @@ -137,6 +137,9 @@ Fri 12pm, Noon # You can use ranges too Fri 05:00-06:00, Breakfast Fri 12pm-1pm, Lunch + +# If you specify multiple times, the event will show up at each of those times +6am 12pm 6pm, Walk the dog ``` ## Adding details to events @@ -145,11 +148,11 @@ Any line starting with a `+` is attached to the nearest above event. This can be ``` 2025 Jan 5 16:00, Doctor's Appointment -+ 123 Gentoo Road, San Francisco, CA 12345 -+ Dr. Elias Berkins, +1 (555)-123-1234 + + 123 Bookworm Road, New York, NY 12345 + + Dr. Raadt, +1 (555)-123-1234 ``` -## Advanced Recurrence (Modified Julian Day `J%x+y`) +## 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. Combined with the modulo operator `%` and an optional `+`/`-` offset this creates complex recurring events. @@ -162,7 +165,7 @@ J%14+2, Every other Saturday (on the other weeks) Sat J%2, Every other Saturday expressed in a different way ``` -Julian date modulus is weird, but it's a concise way to express multiple uncommon recurring patterns without increasing program complexity and syntax vocabulary for features I virtually never use. Plus it's an homage to [When](https://www.lightandmatter.com/when/when.html). +Julian date modulus is weird, but it's a concise way to express multiple uncommon recurring patterns without increasing complexity much for recurrence I virtually never need. Plus it's an homage to [When](https://www.lightandmatter.com/when/when.html). #### Footnote for astronomers and time nerds @@ -179,8 +182,8 @@ Attach a line with `+ Due: DATE` and it will show up in a list of upcoming deadl ``` - Wash car - Clean room -- Give book back to Sally - + Address: 555 Oak Street, Openville +- Give book back to Ada + + Address: 555 Oak Street, Portland, OR - Finish TPS report + Due: Aug 7 2025 |