Claude
653e7a17a3
Brings in the Katan rules engine, board, model and AI (WALA-119), its 51 unit tests and docs/RULES-catan.md. Only conflict was docs/README.md, which the GitHub-lineage migration had dropped: kept the engine branch's index and pointed the CI link (docs/CI.md no longer exists) at the root README. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01JdMNbY5hLR7FjtfEE712xG
1.9 KiB
1.9 KiB
docs/
Conventions for this repo's documentation. Seeded at bootstrap (WALA-118).
Per-game rules: RULES-<game>.md
Every game in GameCatalog gets one file describing how this app implements
it — not a generic rule dump. The rules code
(app/src/main/java/org/prolibertate/games/game/<game>/) is the source of
truth; the doc exists so a human or an agent can check intent against
behaviour without reading Kotlin first.
Naming: the catalogue id, lowercase, e.g. crazy8s → RULES-crazy8s.md.
| Game (catalogue id) | Rules doc |
|---|---|
| Backgammon | RULES-backgammon.md |
| Checkers | RULES-checkers.md |
| Chess | RULES-chess.md |
| Crazy 8s | RULES-crazy8s.md |
| Cribbage | RULES-cribbage.md |
| Euchre | RULES-euchre.md |
| FreeCell | — (TODO) |
| Golf | RULES-golf.md |
| Hearts | — (TODO) |
| Kaiser | RULES-kaiser.md |
Katan (catalogue id catan) |
RULES-catan.md |
| Klondike | — (TODO) |
| Mastermind | RULES-mastermind.md |
| Morris | RULES-morris.md |
| Peg solitaire | — (TODO) |
| Pirates | RULES-pirates.md |
| President | RULES-president.md |
| Pyramid | — (TODO) |
| Sequence | RULES-sequence.md |
| Spider | — (TODO) |
| Ta Yü | RULES-tayu.md |
| Wizard | RULES-wizard.md |
| Yahtzee | — (TODO) |