8000 docs: quick install section at the top of the README by simon-inkie · Pull Request #208 · simon-inkie/inkie-deck · GitHub
[go: up one dir, main page]

Skip to content

docs: quick install section at the top of the README - #208

Merged
simon-inkie merged 1 commit into
mainfrom
docs/readme-quick-install
Nov 18, 2026
Merged

simon-inkie merged 1 commit into
mainfrom
docs/readme-quick-install

Conversation

@simon-inkie
@simon-inkie simon-inkie commented Nov 18, 2026 •
Copy link
Copy Markdown
Owner

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.


Devin Review

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>
@devin-ai-integration devin-ai-integration Bot left a comment
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@simon-inkie
simon-inkie merged commit c68086e into main Nov 18, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

0