Adds the README from the course template: requirements, set up with a local .venv and python -m pip install --upgrade pip for Windows PowerShell, Debian and macOS, run, tests, continuous integration, Doxygen build, project layout and license.
The repository description and 8 topics were set on git.tirsystem.com through its API (not part of the diff).
Verification
From a fresh clone, following the README: setup, pytest (25 passed), ruff check, mypy, python -m coffee_machine, the coffee-machine command and doxygen Doxyfile (no warnings) all work. The README's example session matches the program output.
Notes for the reviewer
This PR is based on mil-001-project-setup, which holds the merged Phase 2 code (PR #17). Phase 2 is not in main yet, because #17 merged into that branch after #16 had merged. Merge mil-001-project-setup into main first, then retarget this PR to main.
framework/scripts/check-readme.sh flags the README because the framework template uses different section headings from the course template. The course template was followed on purpose.
## Summary
- Adds the README from the course template: requirements, set up with a local `.venv` and `python -m pip install --upgrade pip` for Windows PowerShell, Debian and macOS, run, tests, continuous integration, Doxygen build, project layout and license.
- The repository description and 8 topics were set on git.tirsystem.com through its API (not part of the diff).
## Verification
From a fresh clone, following the README: setup, `pytest` (25 passed), `ruff check`, `mypy`, `python -m coffee_machine`, the `coffee-machine` command and `doxygen Doxyfile` (no warnings) all work. The README's example session matches the program output.
## Notes for the reviewer
- This PR is based on `mil-001-project-setup`, which holds the merged Phase 2 code (PR #17). Phase 2 is not in `main` yet, because #17 merged into that branch after #16 had merged. Merge `mil-001-project-setup` into `main` first, then retarget this PR to `main`.
- `framework/scripts/check-readme.sh` flags the README because the framework template uses different section headings from the course template. The course template was followed on purpose.
Closes #12
Closes #13
Closes #14
Closes #15
Write the README from the course template: requirements, setup with a
local .venv for Windows PowerShell, Debian and macOS, run, tests,
continuous integration, Doxygen build, project layout and license.
Verified from a fresh clone: setup, pytest, ruff, mypy, both run
commands and the Doxygen build. The repository description and topics
were set on git.tirsystem.com through its API.
Task: MIL-003#1
Task: MIL-003#2
Task: MIL-003#3
Task: MIL-003#4
Closes#12Closes#13Closes#14Closes#15
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
.venvandpython -m pip install --upgrade pipfor Windows PowerShell, Debian and macOS, run, tests, continuous integration, Doxygen build, project layout and license.Verification
From a fresh clone, following the README: setup,
pytest(25 passed),ruff check,mypy,python -m coffee_machine, thecoffee-machinecommand anddoxygen Doxyfile(no warnings) all work. The README's example session matches the program output.Notes for the reviewer
mil-001-project-setup, which holds the merged Phase 2 code (PR #17). Phase 2 is not inmainyet, because #17 merged into that branch after #16 had merged. Mergemil-001-project-setupintomainfirst, then retarget this PR tomain.framework/scripts/check-readme.shflags the README because the framework template uses different section headings from the course template. The course template was followed on purpose.Closes #12
Closes #13
Closes #14
Closes #15