From d0fe7324370d4826df80f4b691288da317e3c5e7 Mon Sep 17 00:00:00 2001 From: Denis Chevalier Date: Tue, 11 Aug 2026 11:45:44 +0200 Subject: Update README tree and rename LLM{_,-}POLICY.md --- README.md | 33 +++++++++++++-------------------- 1 file changed, 13 insertions(+), 20 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 67ae748..790e82e 100644 --- a/README.md +++ b/README.md @@ -36,31 +36,24 @@ rigorous topological error compensation. ## Repository Structure -```text -. -├── charts/ # Vector charts built with CeTZ-plot -├── diagrams/ # Vector technical drawings & CAD layouts (CeTZ / Zap) -├── lib/ # Executable Typst helper functions & test harness -│ ├── apply-prefix.typ # SI prefix mathematical helper -│ ├── assert-aeq.typ # Float tolerance assertion library -│ └── unify.typ # Curried unit formatting wrappers -├── listings/ # Code examples and calibration log templates -├── tables/ # Modular specification data tables -├── electrical-specifications.typ -├── mechanical-specifications.typ -├── module-design.typ # Theoretical error budgeting & compensation -├── introduction.typ -├── preamble.typ # Document entry point & main layout -└── LICENSE.md # Comprehensive tri-license legal breakdown -└── LICENSES # Actual licences text -``` +* [`README.md`](README.md): This file +* [`CONTRIBUTING.md`](CONTRIBUTING.md): Contribution guidelines +* [`CODE-OF-CONDUCT.md`](CODE-OF-CONDUCT.md): Contributors code of conduct +* [`LLM-POLICY.md`](LLM-POLICY.md): LLM usage policy on the repo +* [`LICENSE.md`](LICENSE.md): Comprehensive tri-license legal breakdown +* `LICENSES/`: Actual licenses text +* `*.typ`: Core text of the specification, one file per level 1 heading +* `charts/`: Vector charts built with CeTZ-plot +* `diagrams/`: Vector technical drawings & CAS layouts (CeTZ) +* `tables/`: Modular specification data tables +* `lib/`: Executable Typst helper functions & test harness ## Compiling the Specification ### Prerequisites -- [Typst CLI](https://github.com/typst/typst) (v0.15.1 or newer) -- Fonts: standard system serif ans sans-serif fonts +* [Typst CLI](https://github.com/typst/typst) (v0.15.1 or newer) +* Fonts: standard system serif ans sans-serif fonts ### Building the PDF -- cgit