docs: complete documentation for Milestone 4

- Rewrite README.md with overview, requirements, setup, run, tests
  sections
- Add docs/flowchart.md with Mermaid diagram and link to diagrams.net
  source
- Update docs/plan.md to mark Milestone 4 as complete
This commit is contained in:
2026-10-04 14:21:13 +08:00
parent 058c2451e0
commit 8d13657773
3 changed files with 103 additions and 4 deletions
+17
View File
@@ -0,0 +1,17 @@
# Blind Auction Flowchart
Original chart: [diagrams.net](https://viewer.diagrams.net/?highlight=0000ff&edit=_blank&layers=1&nav=1&title=Blind%20Auction%20Flow%20Chart)
```mermaid
flowchart TD
A([Start]) --> B[Print welcome message]
B --> C[bids = empty dictionary]
C --> D[/Ask name/]
D --> E[/Ask bid, repeat until valid/]
E --> F[Store bids name = bid]
F --> G{Other bidders?}
G -- yes --> H[Clear screen] --> D
G -- no --> I[Find highest bid]
I --> J[/Print winner/]
J --> K([End])
```
+3 -3
View File
@@ -34,7 +34,7 @@ Work on ONE milestone at a time. Each milestone is one branch (`milestone/NN-nam
## Milestone 4 - Documentation (`milestone/04-docs`)
- [ ] `README.md` from the template (Overview, Requirements, Setup incl. creating/activating `.venv` and `python -m pip install --upgrade pip`, Run, Tests, License AGPL, Links)
- [ ] `docs/flowchart.md` (Mermaid plus link to the diagrams.net chart)
- [ ] Generate Doxygen docs if `doxygen` is installed
- [x] `README.md` from the template (Overview, Requirements, Setup incl. creating/activating `.venv` and `python -m pip install --upgrade pip`, Run, Tests, License AGPL, Links)
- [x] `docs/flowchart.md` (Mermaid plus link to the diagrams.net chart)
- [x] Generate Doxygen docs if `doxygen` is installed
- Verify: README commands work verbatim; `.env` stays untracked