Write the README from the framework template #20

Merged
Tirsvad merged 1 commits from write-readme into main 2026-10-07 19:15:56 +02:00
1 Commits
Author SHA1 Message Date
Tirsvad 8e6bcc4271 Write the README from the framework template
Replace the bare title with a README that follows templates/README-template.md:
overview with the parts of the repository, requirements, setup, run, tests,
license (GNU Affero General Public License v3.0), links and an appendix of the
project documents.

The setup command (pip install -e . --group dev) was tested in a clean virtual
environment: it installs the pinned dependencies and the dev tools, and all 40
tests pass there. The README passes framework/scripts/check-readme.sh.

The framework is a private repository, so the README links to the framework/
submodule entry instead of its pages. AGENTS.md, the dictionary, the
traceability matrix and governance rows are left out because those documents
are not in the repository.
2026-10-08 01:13:20 +08:00