summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 34a2dc6..c494abc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
# sisudoc-ssp-reader
+> **Frozen, and superseded.** This reader is not maintained. Its work is
+> done by `ocda-read` in
+> [sisudoc-ocda-lib](https://git.sisudoc.org/sisudoc-ocda-lib), which reads
+> the `.ssp`, the `.ocda.db` and a pod alike, in D and in Gleam. This
+> repository is kept as the record of the readers written from the
+> specification alone, at the points the specification reached: format 2.0
+> and format 2.1.
+
Readers for the **`.ssp`** document abstraction, the object-centric
document abstraction written as text, which `sisudoc-spine` emits and
reads.
@@ -10,18 +18,17 @@ reads.
|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| [`dlang/`](dlang/) | D. Outline, HTML scroll, breadcrumbed text, JSONL chunks for embedding pipelines, an image manifest, image verification, and `--validate` |
| [`gleam/`](gleam/) | Gleam. Summary, outline, and what it did not understand |
-| `ruby/` | to come |
## Why more than one
-These are not three tools that happen to share a name. They are **the same
+These are not two tools that happen to share a name. They are **the same
specification implemented more than once**, and the interesting thing about
them is that they agree.
Each was written from the format specification, `sisudoc-abstraction-format`,
-rather than from spine's emitter or from each other. Run over the 36
-document reference collection, **the D and Gleam readers agree on the
-section counts of all 36**.
+rather than from spine's emitter or from each other. Run over the markup
+document samples, **the D and Gleam readers agree on the section counts of
+every document-language**.
That is the point of the exercise. A specification that one implementation
follows is a description of that implementation; a specification that two