46 lines
2.1 KiB
Markdown
46 lines
2.1 KiB
Markdown
# docs/formal/
|
|
|
|
The press-ready LaTeX documentation set for StarForth / LithosAnanke.
|
|
Audience: patent counsel, SSRN reviewers, licensees, paying customers,
|
|
hobbyists with hardware in hand. Nothing goes here until it's ready to be
|
|
cited — see `CLAUDE.md` for full authoring conventions, the scraps system,
|
|
and voice/tone rules.
|
|
|
|
Ten publications in three groups, all built from `common/preamble.tex` and
|
|
`common/starship.bib`, assembled largely from `scraps/`:
|
|
|
|
| Group | Directories |
|
|
|-------|-------------|
|
|
| Research volumes | `vol1-vm-physics/`, `vol2-kernel/`, `vol3-research/` |
|
|
| Practitioner books | `dev-guide/`, `user-guide/`, `cookbook/` |
|
|
| Standalone reports | `experiments/`, `proofs/`, `ssrn/`, `patent/` |
|
|
|
|
- **[common/](common/)** — Shared LaTeX preamble and bibliography, `\input{}`
|
|
by every publication.
|
|
- **[scraps/](scraps/)** — Press-ready LaTeX fragments converted from every
|
|
document in `docs/working/`, mirrored by source path.
|
|
- **[vol1-vm-physics/](vol1-vm-physics/)**, **[vol2-kernel/](vol2-kernel/)**,
|
|
**[vol3-research/](vol3-research/)** — The three research volumes.
|
|
- **[dev-guide/](dev-guide/)**, **[user-guide/](user-guide/)**,
|
|
**[cookbook/](cookbook/)** — The three practitioner books.
|
|
- **[experiments/](experiments/)**, **[proofs/](proofs/)**,
|
|
**[ssrn/](ssrn/)** — Three of the four standalone reports.
|
|
**`patent/`** is the fourth — **legal hold, do not touch without Bob's
|
|
instruction.**
|
|
- **[doxygen/](doxygen/)** — Generated Doxygen output (gitignored except the
|
|
committed PDF appendix built from it).
|
|
- **[build/](build/)** — Build output directory (gitignored; only the
|
|
rendered `.pdf` per publication is committed).
|
|
- `Makefile` — builds all ten publications (`make docs-formal` from
|
|
`docs/CLAUDE.md`, or `make -C docs/formal all`).
|
|
- `CLAUDE.md` — authoring conventions (read before adding or editing
|
|
anything here).
|
|
- `fix-doxygen-unicode.py` — post-processes Doxygen XML for LaTeX-safe
|
|
Unicode before the `doxygen` appendix builds.
|
|
|
|
## See also
|
|
|
|
- [`docs/working/README.md`](../working/README.md) — the living-document
|
|
tier this material is promoted from.
|
|
- [Project root](../../README.md)
|