diff options
Diffstat (limited to 'gleam/README.md')
| -rw-r--r-- | gleam/README.md | 44 |
1 files changed, 32 insertions, 12 deletions
diff --git a/gleam/README.md b/gleam/README.md index d586bd3..482db38 100644 --- a/gleam/README.md +++ b/gleam/README.md @@ -1,15 +1,18 @@ # ocda-lib, in Gleam -The abstraction's model and both its loaders, as a Gleam library, and the -two programs that put it to the question. - -| | | -|-----------------|----------------------------------------------------------------------------------| -| `ocda/model` | the document, the object, the image. Depends on nothing but the standard library | -| `ocda/load_ssp` | text -> model | -| `ocda/load_db` | sqlite -> model | -| `ocda/load` | what a path is, and loading it | -| `ocda/dump` | the model written out canonically, as an oracle | +The abstraction's model and both its loaders, as a Gleam library, with its +reader and the two programs that put it to the question. + +| | | +|------------------|-----------------------------------------------------------------------------------------| +| `ocda/model` | the document, the object, the image. Depends on nothing but the standard library | +| `ocda/load_ssp` | text -> model | +| `ocda/load_db` | sqlite -> model | +| `ocda/load` | what a path is, and loading it | +| `ocda/inventory` | what a file holds beyond the one document: its languages, and what a `.ocda.db` carries | +| `ocda/dump` | the model written out canonically, as an oracle | +| `read/main` | `ocda-read`, the reader | +| `ocda_ffi.erl` | a sha256, from OTP's crypto, which the standard library lacks | ## Use @@ -27,6 +30,23 @@ case load.load(path, "en", False) { } ``` +## The reader + +```sh +nix build +./result/bin/ocda-read [--tree|--outline|--languages|--files|--report-unknown] + <file>.ssp|<file>.ocda.db|<file>.zip [lang] +``` + +`ocda-lib read`, installed also as `ocda-read`. The modes the Gleam readers +had, over the library, so each reads every form this library reads; the +others are the D reader's. **Its output is the D `ocda-read`'s, byte for +byte**, in every mode both have. In `src/read/`, because Gleam compiles +nothing outside `src/`; a program depending on the library compiles it too, +and does not use it. + +A `.sisupod` it refuses, saying why: the zstd frame, below. + ## The two programs ```sh @@ -97,6 +117,6 @@ one and the other must change with it. ## Format -Specified in **sisudoc-abstraction-format**: `ocda-model.md` for the model, -`ssp-format-specification.md` and `ocda-db-format-specification.md` for the +Specified in **sisudoc-abstraction-format**: `ocda-model.org` for the model, +`ssp-format-specification.org` and `ocda-db-format-specification.org` for the two serialisations. At format **2.x**. |
