MIL-003 README, source documentation and screenshots #28

Merged
Tirsvad merged 1 commits from mil-003-documentation into main 2026-10-13 09:40:25 +02:00
Owner

Adds README.md in the requested section order, screenshots under docs/images/ rendered from the real program and test output, and verifies the README commands.

Doxygen comments were added with the code in MIL-002; doxygen Doxyfile completes with no warnings.
The Windows PowerShell commands were executed in a fresh venv from a clean git archive; the Debian and macOS commands were not executed in this session.

Closes #17
Closes #18
Closes #19
Closes #20

Mode: autonomous.

Adds README.md in the requested section order, screenshots under docs/images/ rendered from the real program and test output, and verifies the README commands. Doxygen comments were added with the code in MIL-002; `doxygen Doxyfile` completes with no warnings. The Windows PowerShell commands were executed in a fresh venv from a clean `git archive`; the Debian and macOS commands were not executed in this session. Closes #17 Closes #18 Closes #19 Closes #20 Mode: autonomous.
Tirsvad added 1 commit 2026-10-13 09:40:23 +02:00
Add README with set up, run, test, CI, documentation build and screenshots
Tests / Run the tests (pull_request) Successful in 41s
0e73d7d0d0
Closes #17
Closes #18
Closes #19
Closes #20
Tirsvad merged commit 933f71eb39 into main 2026-10-13 09:40:25 +02:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Tirsvad-Udemy-100-days-of-code/025-squirrel#28