filed

Job queue using FUSE

commit c708c07597ac3b99b6879546fda973ccad8da289
parent 83315dc67a531366b209548c312a8b67e498f063
Author: Marc Coquand <marc@coquand.email>
Date:   Tue, 16 Dec 2025 16:04:58 +0100

docs

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

1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # File d'attente
 
-File d'attente (acronym filed) is a simple job queue. It is intended for trusted, single-server workloads, as a companion queue to another application, while also allowing admins to easily inspect and rerun jobs that have failed.
+File d'attente (acronym filed) is a file-base job queue. It is intended for trusted, single-server workloads, as a companion queue to another application, while also allowing admins to easily inspect and rerun jobs that have failed.
 
 File d'attente uses files and directories for manipulation. Creating a job is as simple as adding it to `/pending`, viewing running jobs is as simple as running `ls /active`, and restarting a failed job is as simple as `mv /failed/job /pending`.
 
@@ -17,12 +17,14 @@ File d'attente is built in Go and depends on sqlite and fuse (make sure fusermou
 git clone https://sr.ht/~marcc/filed/
 cd filed
 go build
+go install
 ```
 
-To build the docs you need scdoc
+To build the docs you need [scdoc]
 
 ```
-scdoc < filed.1.scd > filed.1
+$ scdoc < filed.1.scd > filed.1
+# mv filed.1 /usr/local/man/man1
 ```
 
 ## Basic Principles
@@ -108,3 +110,4 @@ I've tried a few other queue tools: sqs/sns, rabbitmq, bull, systemd-run. The fi
 [task-spooler]: https://github.com/justanhduc/task-spooler
 [bull]: https://www.npmjs.com/package/bull
 [man pages]: https://git.sr.ht/~marcc/filed/tree/main/item/filed.1.scd
+[scdoc]: https://git.sr.ht/~sircmpwn/scdoc