Files
ProLibertateGames/docs
adrianoftyrielandPaperclip 4d7cd6182f
Build and Release APK / Build APK and publish release (push) Failing after 7s
Rename the installed Android package to ca.wallacenet.prolibertategames
Follows the Gitea repo rename: the applicationId (and its .dev variant)
now matches the repo, the launcher name and the docs, instead of carrying
the abandoned Pilgrims of Katan identity.

The JVM namespace stays org.prolibertate.games, so no source file moves;
only the installed identity changes.

Co-Authored-By: Paperclip <[email protected]>
2026-10-14 14:47:13 +00:00
..
2026-08-06 13:34:31 +00:00
2026-08-07 05:52:26 +00:00
2026-08-06 03:25:09 +00:00
2026-08-06 18:09:10 +00:00

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
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)

Other docs

  • CI.md — build, CI, releases, OTA decisions.
  • licenses/ — third-party licences that must travel with the app (Uncial Antiqua under the SIL OFL; the app itself is GPL-3.0, see /LICENSE).
  • Repo-level agent notes live in CLAUDE.md at the root.