README: trim install section, add Windows#121
Conversation
The install section was carrying details that belong elsewhere:
- "Downloads a self-contained finalrun binary into ~/.finalrun/bin/,
adds it to your PATH, downloads the per-platform runtime tarball,
prompts for Android/iOS, installs host tools..." — internals of
install.sh, already documented in the script's header comment and
in the auto-generated release notes (.github/release-notes-template.md).
- "For CI / non-interactive environments..." — CI flag and env-var
documentation, already in release notes and install.sh's --help.
- "After install, run finalrun doctor..." — diagnostic guidance that
fits better in finalrun --help / docs/troubleshooting.md.
A README install block should answer "how do I get this on my machine"
in one or two commands, not document the installer's behavior. Trimmed
to just the install one-liners per platform plus a single sentence on
the iOS-on-Windows constraint (preempts the most common support
question without expanding the section).
Adds Windows install instructions for the first time. Until v0.1.10,
the .ps1 installer didn't exist; v0.1.10 shipped it (commit 9d5b78e on
PR #120) and the .exe / runtime tarball are now on every release. The
README continues to point only at install.sh and ignores Windows —
this catches it up.
Net: 14 lines → 6 lines, +1 platform.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 24 minutes and 7 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
Summary
Trims the README install section from ~14 lines to 6, and adds Windows install instructions (which were missing entirely — v0.1.10 shipped
install.ps1but the README never mentioned it).What changed
Before (lines 52-68):
install.shdoes internally (binary location, PATH, runtime tarball, prompts, host tools, skills, "no Node.js required")--ciinstall block with explanationCI=1env auto-detectAfter:
Why these details belong elsewhere (and already do)
~/.finalrun/bin/, adds it to PATH, prompts for Android/iOS, installs host tools…"--ciflag +CI=1auto-detectinstall.sh --helpfinalrun --helplists doctor as a top-level command; troubleshooting docs go deeperThe README's job at "Install" is "get me started in one command per OS." Implementation details belong with the implementation.
What I kept
The iOS-on-Windows clarifier:
This preempts the most common "why doesn't iOS work on Windows?" question. The release notes mention it too, but the README is where someone evaluates the tool before clicking through to releases — having the constraint visible at evaluation time avoids a wasted install.
Test plan
Why a separate PR
Docs-only, no version bump, no release workflow. Lands directly on main and is immediately live. Keeping this isolated from v0.1.10's release commit makes the diff focused on one judgment call (what to keep vs trim) rather than mixing docs taste with release mechanics.
🤖 Generated with Claude Code