ref: 0f18bf0aaf945b20b24f3ec8f3ae37f42c9e08b7
parent: 66deaa106179d8362745bbd367a25b06612863ae
author: sirjofri <[email protected]>
date: Thu Oct 17 08:52:59 EDT 2024
adds rough readme file
--- /dev/null
+++ b/README.md
@@ -1,0 +1,43 @@
+# VCARD filesystem and library
+
+## Contents
+
+- `libvcard`: library for parsing and writing vcard data
+- `vcffs`: vcard filesystem (vcf fs); name might change in the future
+
+## Usage
+
+### vcffs
+
+Usage: vcffs [-m mtpt] [-s srv] database.vcf
+
+ /mnt/vcf/
+ ctl
+ import
+ John_Doe/
+ fn/
+ data
+ params/
+ ...
+ n/
+ data
+ ...
+ tel/
+ data
+ ...
+ Jane_Doe/
+ ...
+
+Future plans:
+
+- Make files writable
+- ctl: make commands work
+- import: make import work
+- files: output with newline at the end?
+
+### libvcard
+
+- see `libvcard/vcard.h`
+- `Vcard* vcparse(char *str)`
+- `Vcard* vcparsefile(char *file)`
+- ...