Writes the README. It was only the title line; the repository's front page on Gitea now explains the project.
The README follows the framework's template, section for section, in the template's order: overview with a table of the repository's parts, requirements, setup, run, tests, license, links and an appendix of the project documents.
Checked rather than assumed
framework/scripts/check-readme.sh reports no finding.
The setup command, pip install -e . --group dev, was tested in a clean virtual environment on a scratch copy: it installs the pinned dependencies and the dev tools, and all 40 tests pass there. That is why the README asks for pip 25.1 or newer.
Every relative link resolves to a file or folder in the repository; there are no leftover template placeholders.
The license named is the one in LICENSE: GNU Affero General Public License v3.0.
Choices to know about
The framework is a private repository, so the README links to the framework/ submodule entry in this repository instead of the framework's own pages, which a visitor cannot open.
Template rows for documents that are not in the repository are left out: AGENTS.md (no longer tracked), the domain dictionary, the traceability matrix and governance. I added one row for the review records.
It describes what is on main today (the white-shade filter, 40 test cases). When MIL-003 lands, the palette sentence and the test count need updating.
Only README.md changes.
Issues
No issue closed: this is documentation that no task of MIL-001 or MIL-002 covers.
## Summary
Writes the README. It was only the title line; the repository's front page on Gitea now explains the project.
The README follows the framework's template, section for section, in the template's order: overview with a table of the repository's parts, requirements, setup, run, tests, license, links and an appendix of the project documents.
**Checked rather than assumed**
- `framework/scripts/check-readme.sh` reports no finding.
- The setup command, `pip install -e . --group dev`, was tested in a clean virtual environment on a scratch copy: it installs the pinned dependencies and the dev tools, and all 40 tests pass there. That is why the README asks for pip 25.1 or newer.
- Every relative link resolves to a file or folder in the repository; there are no leftover template placeholders.
- The license named is the one in `LICENSE`: GNU Affero General Public License v3.0.
**Choices to know about**
- The framework is a private repository, so the README links to the `framework/` submodule entry in this repository instead of the framework's own pages, which a visitor cannot open.
- Template rows for documents that are not in the repository are left out: `AGENTS.md` (no longer tracked), the domain dictionary, the traceability matrix and governance. I added one row for the review records.
- It describes what is on `main` today (the white-shade filter, 40 test cases). When MIL-003 lands, the palette sentence and the test count need updating.
Only `README.md` changes.
## Issues
No issue closed: this is documentation that no task of MIL-001 or MIL-002 covers.
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.
Tirsvad
merged commit d309db5c44 into main2026-10-07 19:15:56 +02:00
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Summary
Writes the README. It was only the title line; the repository's front page on Gitea now explains the project.
The README follows the framework's template, section for section, in the template's order: overview with a table of the repository's parts, requirements, setup, run, tests, license, links and an appendix of the project documents.
Checked rather than assumed
framework/scripts/check-readme.shreports no finding.pip install -e . --group dev, was tested in a clean virtual environment on a scratch copy: it installs the pinned dependencies and the dev tools, and all 40 tests pass there. That is why the README asks for pip 25.1 or newer.LICENSE: GNU Affero General Public License v3.0.Choices to know about
framework/submodule entry in this repository instead of the framework's own pages, which a visitor cannot open.AGENTS.md(no longer tracked), the domain dictionary, the traceability matrix and governance. I added one row for the review records.maintoday (the white-shade filter, 40 test cases). When MIL-003 lands, the palette sentence and the test count need updating.Only
README.mdchanges.Issues
No issue closed: this is documentation that no task of MIL-001 or MIL-002 covers.