docs(readme): recommend pip install over prebuilt binary#16
Merged
Conversation
Reorder the installation methods so "From PyPI" (pip install) is listed first and marked as recommended, with the prebuilt binary moved to second place. Mirror the change in README_zh.md to keep bilingual parity. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Sodawyx <sodawyx@126.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the project documentation to recommend installing AgentRun CLI from PyPI first, while keeping the prebuilt binary option available as the second installation method, and maintaining parity between the English and Chinese READMEs.
Changes:
- Reordered the Installation section in
README.mdto list From PyPI (recommended) before Prebuilt binary. - Mirrored the same installation-order change in
README_zh.md(从 PyPI 安装（推荐） first, then 预编译二进制). - Removed the “(recommended)” label from the prebuilt-binary headings in both documents.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Reorders Installation sections to recommend PyPI install first and moves prebuilt binary to second. |
| README_zh.md | Mirrors the same Installation reorder and recommendation labeling for bilingual consistency. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What
Reorder the Installation section in both READMEs so that From PyPI (
pip install agentrun-cli) is listed first and marked as the recommended method, with the Prebuilt binary moved to second place.New order in both languages: PyPI → Prebuilt binary → From source → Verify.
Why
pip installis the simplest path for the typical Python-based user/CI flow, so it should be the primary recommendation. The prebuilt binary remains available for environments without Python.Changes
README.md—From PyPImoved to top with(recommended); removed(recommended)tag from the prebuilt-binary heading.README_zh.md— mirrored the same reorder (从 PyPI 安装（推荐）first,预编译二进制second) to keep bilingual parity.Docs-only change; no code, options, or commands were modified.
🤖 Generated with Claude Code