docs(readme): badge row + status callout + PyMuPDF quick-start fix#234
Merged
Conversation
…ap (F3) Live mode quick start (`bun install` + `bun run start`) never mentioned the Python 3 venv + PyMuPDF requirements.txt prerequisite that lib/pdf-generator.ts hard-depends on for the only PDF renderer. CI's own test.yml installs this in a separate step; a first-time user following just the two stated commands hit a PDF-render subprocess failure with no guidance. Added the same venv + pip install step CI runs, before `bun run start`. Also added the CI/License/Status badge row and the verbatim active-status callout under section-12's freeze carve-out (both explicitly permitted as additive voice-clean edits, no existing prose touched). Repo-metadata (About/topics/homepage) already conforms; not touched here. Verified: bun run test:run tests/unit/readme.test.ts (49 passed), bun run typecheck clean. Two remaining COMPETE atoms (intro-paragraph placement, section order) staged to tournament-atoms-gtm_ops.json for the cross-provider tournament phase, out of scope for this mechanical pass. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
github-actions
Bot
added
the
pr-needs-issue
…ection-order Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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
Live modequick start (bun install+bun run start) never mentioned the Python 3 venv + PyMuPDFrequirements.txtprerequisite thatlib/pdf-generator.tshard-depends on as the sole PDF renderer. Mirrors CI's owntest.yml"Install PyMuPDF renderer dependency" step.Test plan
bun run test:run tests/unit/readme.test.ts— 49 passedbun run typecheck— cleanCo-Authored-By: Claude Fable 5 noreply@anthropic.com