agendafs

A filesystem for your calendar.

commit 2c61f06aa456630dd3c7c199ed46f313718dd8de
parent 10d6f44f6aa113853131c0fbb4d80d5b8c598b72
Author: Marc Coquand <marc@coquand.email>
Date:   Wed, 23 Jul 2025 10:52:27 +0200

README

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

1 file changed, 8 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ To build:
 
 ```
 git clone https://sr.ht/~marcc/agendafs/
+cd agendafs
 make
 ```
 
@@ -26,12 +27,12 @@ make
 
 Agendafs uses [vdirsyncer](https://vdirsyncer.pimutils.org/) as a backend to sync iCalenar files to a remote caldav server.
 
-Each VJOURNAL iCalendar entry (VTODO and VEVENTS in todo tracker) is represented as a file or directory in Agendafs. Edit these files like you would on a regular filesystem. iCalendar entries that have a parent relationship are represented as directories. iCalendar attributes can also be accessed via xattr(7). Current supported attributes are:
+Each VJOURNAL iCalendar entry is represented as a file or directory in Agendafs. Edit these files like you would on a regular filesystem. iCalendar entries that have a parent relationship are represented as directories. iCalendar attributes can also be accessed via xattr(7). Currently supported attributes are:
 
 - `user.categories` - comma separated list of categories
 - `user.class` - Can be either private, public, confidential.
 
-Agendafs pairs well with file explorers like `lf` or `nnn`.
+Agendafs pairs well with file explorers like `ranger`, `lf` or `nnn`.
 
 ## Usage
 
@@ -51,37 +52,17 @@ for directories).
 
 ## Motivation
 
-Caldav is great in the sense that it has a lot of support from various
-apps. However, the format is not particularly human-friendly. For example, VJOURNAL entries look like this:
+I like plaintext notes, but found it hard to sync them and use them on mobile. The beauty of caldav is that you most likely have one if you're signed up an email provider, so you can take advantage of it and use it for sync.
 
-```
-  BEGIN:VJOURNAL
-  UID:19970901T130000Z-123405@host.com
-  DTSTAMP:19970901T1300Z
-  DTSTART;VALUE=DATE:19970317
-  SUMMARY:Staff meeting minutes
-  DESCRIPTION:1. Staff meeting: Participants include Joe\, Lisa
-    and Bob. Aurora project plans were reviewed. There is currently
-    no budget reserves for this project. Lisa will escalate to
-    management. Next meeting on Tuesday.\n
-    2. Telephone Conference: ABC Corp. sales representative called
-    to discuss new printer. Promised to get us a demo by Friday.\n
-    3. Henry Miller (Handsoff Insurance): Car was totaled by tree.
-    Is looking into a loaner car. 654-2323 (tel).
-  END:VJOURNAL
-```
-
-These are not really intended to be edited by users.
+Caldav also have some interesting social features. There is a lot of opportunities to have shared notes, shared todo lists and shared calendars with friends and family this way.
 
-## Contributions
+## Contribute
 
 See [tickets](https://todo.sr.ht/~marcc/agendafs) and [mailing
 list](https://lists.sr.ht/~marcc/agendafs)
 
 ## Appendix
 
-Below are some various scripts and notes.
-
 ### VJOURNAL support in Caldav
 
 To have vjournal support on Nextcloud, I needed to create the calendar manually. This is probably also required in Fastmail.
@@ -126,8 +107,7 @@ $ find . -type f -exec getfattr -n user.categories {} + 2>/dev/null | grep -B1 "
 
 ### Find files by category with nnn
 
-The following function can be added to your profile to search for files
-that have the right category.
+Add the following function to your profile to search for files matching a category.
 
 ```sh
 find_by_category() {
@@ -149,11 +129,7 @@ find_by_category() {
 }
 ```
 
-Usage: `$ find_by_category MY_CATEGORY | nnn`
-
-### lf
-
-Updates might not be reflected with dircache set to true. This is probably because inodes are not updated correctly yet.
+Usage: `find_by_category MY_CATEGORY | nnn`
 
 ### Why C?