docs(readme): pre-alpha disclaimer + honest status#35
Conversation
Prominent top-of-README disclaimer block stating the project is pre-alpha and not a playable game today. Lists verified vs not- verified pieces, points readers at the retraction + Unciv research docs, sets realistic expectations for cloning today. Architecture diagram updated to show the save-edit tool as the unimplemented critical-path piece. Milestone status grid honestly shows bridge-side ✅ alongside Unciv-side ❌ for M1/M2. Added a "what this is" footer note explaining the project's experimental nature and the choice to publish in honest current state rather than polished-looking-but-broken state. No code changes. 248 tests still pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to accurately reflect the project's pre-alpha status, explicitly stating that the game is not yet playable and detailing the unimplemented integration with Unciv. The changes include updated architecture diagrams, a revised development roadmap, and clearer setup instructions for the TUI sandbox and bridge daemon. Review feedback identifies a filename inconsistency in the architecture diagram and notes the omission of the scripts directory from the repository layout section.
| │ │ │ | ||
| ▼ ▼ ▼ | ||
| Textual TUI ./saves/ [save-edit tool: NOT BUILT] | ||
| (live view) kingdom.json │ |
There was a problem hiding this comment.
The architecture diagram refers to kingdom.json, but the project consistently uses kingdom_save.json elsewhere (e.g., lines 74, 95, and in bridge/save_exchange.py). Updating this will ensure documentation consistency.
| (live view) kingdom.json │ | |
| (live view) kingdom_save.json │ |
| tests/ TUI tests (incl. Pilot) | ||
| mod/ClaudeKingdoms/ Unciv mod content (JSON only; unvalidated) | ||
| docs/ PRD, ADRs, schema, hooks-setup, audit, research | ||
| .github/workflows/ CI (pytest on push/PR) |
There was a problem hiding this comment.
The scripts/ directory is missing from the repository layout section, although it is still referenced in the "Testing" section (line 190). It should be included to provide a complete overview of the project structure.
| .github/workflows/ CI (pytest on push/PR) | |
| scripts/ Auxiliary scripts (hello-world smoke, hook logger PoC) | |
| .github/workflows/ CI (pytest on push/PR) |
1 participant
Prominent top-of-README disclaimer that the project is pre-alpha and not a playable game today. Lists verified vs unverified pieces; points at the retraction + Unciv research docs; sets realistic expectations for a fresh clone. Architecture diagram + milestone grid updated to honestly show the save-edit tool as the unimplemented critical path.