added comments to config file

1 files changed, 19 insertions, 1 deletions

diff --git a/soon.conf.example b/soon.conf.example
index 9c722ec..bf5466a 100644
--- a/soon.conf.example
+++ b/soon.conf.example
@@ -1,9 +1,16 @@
 [Calendar]
+# Path and filename of calendar file
 path=/home/user/.config/soon
 defaultFile=calendar.soon
+
+# Number of default past and future days to display
 past=0
 future=14
+
+# Editor for soon -e command to open calendar
 editor=vim
+
+# Default soon arguments, e.g. soon -atd
 defaultCommand=atd
 
 [Todo List]
@@ -11,9 +18,20 @@ alwaysPrint=true
 
 [Archive]
 path=/home/user/.config/soon/archive
+
+# Whether archived events in the past/future show on the calendar
 showFutureArchivedEvents=true
 showPastArchivedEvents=false
+
+# Keep all events on the calendar until manually archived
+# If you use calendars like a todo list you might want this
+# E.g. you put things like "Oil change" on your calendar but you don't always
+# do it in time so you want it to stick around
 alwaysShowUnarchivedEvents=true
+
+# Everything before this date is considered archived
 startDate=2026-01-01
+
+# When you archive the last instance of an event from the TUI, this will delete
+# the event from your calendar
 deleteFromCalendarFile=true
-autoPurge=true