diff options
| -rw-r--r-- | LICENSE.md | 2 | ||||
| -rw-r--r-- | LLM-POLICY.md (renamed from LLM_POLICY.md) | 0 | ||||
| -rw-r--r-- | README.md | 33 |
3 files changed, 14 insertions, 21 deletions
@@ -66,7 +66,7 @@ licenses (`CC-BY-SA-4.0`, `CERN-OHL-S-2.0+`, `GPL-3.0-or-later`). strong copyleft, attribution, and source-sharing requirements of the respective licenses. * **Contributor AI Policy:** For rules regarding human contributor usage of AI - tools during submission, refer to [`LLM_POLICY.md`](LLM_POLICY.md). + tools during submission, refer to [`LLM-POLICY.md`](LLM-POLICY.md). ## Summary of SPDX Identifiers diff --git a/LLM_POLICY.md b/LLM-POLICY.md index ecee3bc..ecee3bc 100644 --- a/LLM_POLICY.md +++ b/LLM-POLICY.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 |