docs: surface INSTALL.md as the canonical install procedure#37
Merged
Conversation
Merged
The INSTALL.md reference was buried in the middle of a paragraph, so agents and humans skimming the README often missed that the step-by-step install lives in a separate file written to be followed verbatim. Promote the link to a lead-in sentence under ## Installation so the canonical procedure is the first thing a reader sees, and frame the Claude-prompt block explicitly as a delegation of that procedure. Drop the trailing 'Full step-by-step instructions Claude follows live in INSTALL.md' sentence now that the same pointer lives up top.
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
The
INSTALL.mdreference was buried in the middle of a sentence at the end of the install paragraph, so agents and humans skimming the README often missed that the step-by-step install lives in a dedicated file written to be followed verbatim. Promote it to a lead-in line under## Installationso the canonical procedure is the first thing a reader sees, and frame the Claude-prompt block explicitly as a delegation of that procedure.Code changes
README.md:26— Added a lead-in sentence under## Installationthat namesINSTALL.mdas the canonical install procedure.README.md:32— Dropped the trailing Full step-by-step instructions Claude follows live in INSTALL.md sentence now that the same pointer lives up top (avoids double-advertising the same file).How to test
README.mdon the PR.## Installationopens with a bolded[INSTALL.md](INSTALL.md)reference before theAsk Claude Code:prompt block.