MIL-004: Add README and verify documentation #33

Merged
Tirsvad merged 1 commits from mil-004-documentation-and-release into main 2026-10-04 15:10:19 +02:00
1 Commits
Author SHA1 Message Date
Tirsvad db477d99fb Add README with setup, run and test instructions
MIL-004 Documentation and release.

- Write README.md from the project template: overview, requirements,
  setup with a local .venv and pip upgrade, run, tests, AGPL license
  and links
- Document building the API docs with doxygen Doxyfile
- Verified: doxygen builds without warnings, and a clean copy installs,
  runs and passes the 13 tests following only the README

Closes #26
Closes #27
Closes #28

Task: MIL-004#1
Task: MIL-004#2
Task: MIL-004#3
2026-10-04 21:06:50 +08:00