Repository navigation
docs: quick install section at the top of the README - #208
Merged
Merged
Conversation
Prerequisites, the two setup commands, a Windows (WSL) pointer, what you will see on first run, and a link to INSTALL.md for the full instructions. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.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
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.
Puts the install steps where people land. Adds a "Quick install" section at the top of the README: what you need first (versions taken from INSTALL.md and the engines and packageManager fields), the two setup commands (copied from INSTALL.md "Quick setup"), a Windows pointer (WSL2, keep the clone in the Linux home, not under C:), what you see on first run, and a link to INSTALL.md for the full instructions and the manual tiers. Replaces the old "To run it, see INSTALL.md" paragraph, keeping its still-true details.
Checks: all new relative links and anchors resolve, leak gate and dash scan clean, diff check clean. Docs only. Note: no rig stage runs README shell blocks (the rig reads INSTALL.md), so the commands here are covered only because they are copied from there.