agendafs

A filesystem for your calendar.

commit 1f355502c3832b03440cd0f5fd04afee90617c4f
parent e7197cbae2801a2207e85ea9ccce155a873619dc
Author: Marc Coquand <marc@coquand.email>
Date:   Mon,  2 Jun 2025 10:24:16 +0100

Add install instructions

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

1 file changed, 21 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -63,6 +63,27 @@ Run
 make
 ```
 
+## Using
+
+Note: This is still in early alpha. It will change, break and more. Don't
+use it for any critical data.
+
+To make testing safer, create a dedicated calendar for just your journal
+files in your caldav server.
+
+Then set up [vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/installation.html).
+
+Once setup, you will have a directory of all your calendars. Locate the one that you are going to use for journals.
+
+Now, set the `CALDAVFS_ICS_DIR` variable and run:
+
+```
+mkdir /tmp/journal
+export CALDAVFS_ICS_DIR=~/.calendars/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/
+# -d -f to launch in debug mode, see libfuse for more options
+mount_caldavfs -d -f /tmp/journal
+```
+
 ## Status
 
 POC stage, still very early alpha.