1.1 KiB
1.1 KiB
Step 0: readme-usage-flow
Read First
- /AGENTS.md
- /PLAN.md
- /PROGRESS.md
- /docs/HARNESS.md
- /docs/IMPLEMENTATION_PLAN.md
- /README.md
- /phases/7-mvp-quality-hardening/index.json
Task
Update README usage flow for the MVP CLI.
Document install, validation, basic conversion, formula parser modes, runtime modes, output layout, resume, and logs.
Sprint Contract
- Done means: a user can follow README instructions to run the local CLI on Windows after environment setup.
- Hard thresholds: commands match implemented CLI; docs do not promise PyQt or hosted API as MVP; generated output contract is accurate.
- Files owned:
README.md, docs as needed,PROGRESS.md,phases/8-release-docs-packaging/index.json. - Dependencies: MVP quality hardening complete.
Acceptance Criteria
python scripts\validate_workspace.py
Verification
- Run the acceptance command.
- Confirm documented commands are copy-pasteable in PowerShell.
- Update
PROGRESS.mdand this phase index.
Do Not
- Do not document unimplemented features as available.
- Do not add marketing-style content.
- Do not include model weights in the repository.