docs: README hero — ▶ Try in 10 minutes + ASCII workflow#34
Merged
Conversation
The first thing a stranger sees on the repo should be something they can *run*. Insert a small hero block above "Motivation" / "动机": 1. ▶ Try in 10 minutes — 4-line shell snippet that drives `examples/quickstart/` to a real `evolution/accepted` commit in ~1 second, $0, no API key. Links to the quickstart README and to examples/oss_fix_demo/ for the LLM-driven version. 2. How the loop works — a compact ASCII diagram showing Observe → Plan → Execute → Evaluate → accept/reject → ledger. Sits where a reader naturally lands after the call-to-action. Both README.md and README.zh.md updated in parity. No prose rewritten; the existing investor-narrative Motivation / SWE-bench worked-example sections are intact below. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This was referenced May 17, 2026
Merged
There was a problem hiding this comment.
Pull request overview
Adds a “hero” onboarding section to the top of the English and Chinese READMEs, giving new visitors a copy/paste quickstart and a compact ASCII diagram explaining the Observe → Plan → Execute → Evaluate loop and accept/reject + ledger flow.
Changes:
- Inserted a “▶ Try in 10 minutes” (and Chinese equivalent) blockquote with a runnable quickstart command snippet targeting
examples/quickstart/. - Added an ASCII workflow diagram + short explanation of accept/reject behavior and ledger-based state reconstruction.
- Kept the rest of the existing README content structure intact by inserting the hero above “Motivation/动机”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds quickstart CTA snippet and ASCII loop diagram above Motivation. |
| README.zh.md | Mirrors the same CTA snippet and ASCII loop diagram above 动机 for language parity. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > --loop | ||
| > ``` | ||
| > | ||
| > Closes the full loop in **~1 second**, **\$0**, **no API key**. See [examples/quickstart/](examples/quickstart/) for what just happened. For the LLM-driven version on a real OSS target, see [examples/oss_fix_demo/](examples/oss_fix_demo/). |
| > --loop | ||
| > ``` | ||
| > | ||
| > 整个闭环 **~1 秒** 跑完，**\$0**，**无需 API key**。详见 [examples/quickstart/](examples/quickstart/)。需要 LLM 驱动的真实 OSS 修复案例，见 [examples/oss_fix_demo/](examples/oss_fix_demo/)。 |
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.
Closes #33.
Summary
Adds two short blocks above "Motivation" in both README.md and README.zh.md:
What didn't change
Test plan
🤖 Generated with Claude Code