agendafs

A filesystem for your calendar.

commit 0ece7056243b3754af702545dd53a0013aeb72dd
parent 25041ea993bd7df5e786e55ec442676b22c284f5
Author: Marc Coquand <marc@coquand.email>
Date:   Wed, 25 Jun 2025 20:52:57 +0100

Update readme

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

1 file changed, 3 insertions(+), 59 deletions(-)
diff --git a/README.md b/README.md
@@ -13,22 +13,7 @@ $ mount_caldavfs /tmp/local-journal
 
 Now your `.ics` files are available as plain-text files:
 
-```
-$ cat /tmp/local-journal/19970901-13:00.txt
-Staff meeting minutes
----
-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.
-2. Telephone Conference: ABC Corp. sales representative called to discuss new printer. Promised to get us a demo by Friday.
-3. Henry Miller (Handsoff Insurance): Car was totaled by tree. Is looking into a loaner car. 654-2323 (tel).
-```
-
-You can edit, move, and delete files with your favorite editor:
-
-```
-$ vim /tmp/local-journal/19970901-13:00.txt
-$ # when done vdirsyncer can sync it back to your caldav server
-$ vdirsyncer sync
-```
+WARNING: Still under construction, expect things to change and break
 
 ## Motivation
 
@@ -54,10 +39,6 @@ app. However, the format is not particularly human-friendly. For example, VJOURN
 
 These are not really intended to be edited by users.
 
-## Status
-
-Early alpha. Very WIP.
-
 ### Planned features
 
 - [x] VJOURNAL - Now the first true journaling filesystem!
@@ -69,11 +50,9 @@ Early alpha. Very WIP.
 	- [x] Rename
 	- [x] Write
 	- [x] Set creation dates - not mandatory but supresses a few warnings
-	- [ ] Directory structure
+	- [ ] Directory structure, children are VJOURNALs with parent as VJOURNAL
 	- [ ] Use DTSTART;VALUE=DATE: for journal to separate them from notes.
-- [ ] A new file format.
-- [ ] Categories (Maybe symlinks?)
-- [ ] Relationships 
+- [ ] Categories 
 - [ ] VTODO
 	- [ ] Embed in VJOURNAL using parent relationship
 - [ ] VEVENTS
@@ -94,24 +73,6 @@ like [vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/when.html#).
 $ make
 ```
 
-## The file format (Draft)
-
-```
---1 Blocks
-
-I'm thinking that the structure that would make the most
-
-sense is a block based structure.
-
---2 [ ] Would be a todo
---3 [ ] Would be another todo
---4 Stiching together notes @category
-
-It'd be possible to have a subnote, which would reference this as a parent.
-
-A number beforehand would be an ID for the note, allowing you to move them around.
-```
-
 
 ## Using
 
@@ -160,23 +121,6 @@ curl -X MKCALENDAR \
 ```
 
 
-## Format
-
-### VJOURNAL
-
-`VJOURNAL` entries have the following format
-
-file name: creation date (`%Y%m%d-%H:%M.txt`)
-
-```
-summary
----
-Longer text
-```
-
-The `---` are mandatory.
-
-
 ## Tool-specific notes
 
 ### lf