filed

Job queue using FUSE

commit cedcda11d3a056a9fa50150aaeea8c1a26c747b7
parent 3e8025f34abad9970c4cfa649f4a49026baeb6a8
Author: Marc Coquand <marc@coquand.email>
Date:   Sun, 14 Dec 2025 19:54:49 +0100

Update readme

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

1 file changed, 20 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -22,23 +22,36 @@ cd qj
 go build
 ```
 
-## Quick start
+To build the docs you need scdoc
+
+```
+scdoc < qj.1.scd > qj.1
+```
+
+## Basic Principles
+
+Below are some examples to get you started. See the [man pages](https://git.sr.ht/~marcc/qj/tree/main/item/qj.1.scd) for more complete documentation
 
 ### Creating a job
 
+In one terminal, start the process:
+
 ```
-$ # In terminal one
 $ mkdir /tmp/qj-jobs
 $ qj /tmp/qj-jobs /tmp/qj-state.db
 ```
 
-In terminal two:
+In terminal two, create a basic job:
 
 ```
 $ printf "echo 'Running job'" >> /tmp/qj-jobs/pending/1
 ```
 
-Note: Each job name must be unique. See man pages for examples to generate an ID.
+If all went well, you can see the job output:
+
+```
+$ cat /tmp/qj-jobs/complete/1
+```
 
 ### Restarting a job
 
@@ -53,3 +66,6 @@ $ mv /tmp/qj-jobs/failed/1 /tmp/qj-jobs/pending
 ```
 $ cat /tmp/qj-jobs/active/1
 ```
+
+
+