README: say how to start the game, pick pygame, and run the image - #204
Merged
Merged
Conversation
The README described four front-ends but never how to launch the default console one, how to switch to pygame (edit INTERFACE_TYPE in src/fishE.py), what install.sh/uninstall.sh do, or that the Dockerfile packages the in-browser build. The INTERFACE_TYPE comment still called the web front-ends "a future web type"; point it at their own entry points instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (docs-only PR, CI
Findings:
Verdict: ready to merge. No protected paths are touched ( This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Stage A documentation accuracy sweep. The README was checked against the source, and one gap was found: it describes four front-ends but never says how to start any of the terminal ones.
python3 src/fishE.pyfor the default console front-end; what./run.shactually does (git pull, installs pygame/pytest/requirements, runs the suite, starts the game only if it passes, perrun.sh); how to switch to pygame (theINTERFACE_TYPEconstant insrc/fishE.py, whichFishE()in__main__defaults to); and whatinstall.sh/uninstall.shdo.Dockerfilebuildsweb/game.zipand runsweb/serve.pywithFISHE_WEB_HOST=0.0.0.0,FISHE_WEB_PORT=8080, and no save volume. None of this was mentioned in the README.src/fishE.pycomment only: theINTERFACE_TYPEcomment still referred to "a future web type". It now points at the two browser entry points (examples/web_app.py,web/pyodide_main.py). No code changed.Other README claims were checked and found accurate: fishing hours and energy cost, the $10,000 goal and the $1,000 reveal, export hold sizes and markets, the housing ladder, investment property names, menu labels, the save-slot summary, and the web and save-dir environment variables.
No tracking issue: the gap was found during the triage sweep, and no issues were open at triage time.
Test plan
Run Unit Testsgreen on the PR headinstall.sh,uninstall.shanddocker buildwere not executed. Shell scripts can't be run in this environment, and CI doesn't run them. The text was written from reading the files.This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson