agendafs

A filesystem for your calendar.

commit 107fc9808b911f551354fb501a945e8a824dbddc
parent b04e20707adcb9b5ef486f83f3a3dc076a0f81d2
Author: Marc Coquand <marc@coquand.email>
Date:   Wed,  9 Jul 2025 23:46:09 +0200

Update README

references: https://todo.sr.ht/~marcc/agendafs/1

Diffstat:
M
README.md
 | 
21
++++++++++++---------

1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ for directories).
 
 ## Dependencies
 
-Some C compiler along with libfuse, libical and pkg-config.
+Some C compiler along with libfuse, libuuid, libical and pkg-config.
 
 Right now you also need a tool that syncs .ics files with a caldav server,
 like [vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/when.html#).
@@ -75,16 +75,19 @@ $ make
 
 ```
 $ mkdir /tmp/journal
-$ export CALDAVFS_ICS_DIR=~/.calendars/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/
-$ # see libfuse for more options
-$ mount_agendafs  /tmp/journal
-$ # Or if you are for some reason not using plan9 rc, replace
-$ # `{date +'...'} with $(date +'...')
-$ new_file=/tmp/journal/`{date +'%Y%m%d-%H:%M'}
-$ touch $new_file
-$ $EDITOR $new_file
+$ mount_agendafs -o icsdir=/home/me/.calendars/my-journal /tmp/journal
+$ $EDITOR "/tmp/journal/My first note"
 ```
 
+You can interact with it mostly like any other filesystem, and so agendafs
+pairs very well with [nnn](https://github.com/jarun/nnn), [lf](https://github.com/gokcehan/lf) and more.
+
+`agendafs` also levarages `xattr(7)`. It exposes the following properties:
+
+- `user.categories`
+
+See [TODO](https://todo.sr.ht/~marcc/agendafs) for current status.
+
 ### VJOURNAL support in Caldav
 
 To have vjournal support on Nextcloud, I needed to create the calendar manually...