docs: accurate README - #20
Merged
Merged
Conversation
github-actions
Bot
added
the
pr-needs-issue
|
This PR needs an issue link. Add |
3 tasks
wranngle
added a commit
that referenced
this pull request
Jul 11, 2026
## Summary - PR #8 (318990c, 2026-05-16) deleted the badge row, `[!NOTE]` status callout, and blockquote tagline that the 2026-05-03 readme-system stamp had produced. Neither #8 nor the later #20 accuracy fix restored them. - Restores, verbatim where prior wording existed in git history (721facf): tagline, badge row (CI + License + Status-active), status callout. - Adds `## Quick start` (new, not previously present): `git clone` + `cd` + `pip install pytest && pytest`, since this is the only runnable-today path without an external QuantConnect account. - Reorders sections to the spec's required order (tagline, badges, callout, quick start, what it does, domain sections, usage, license). - Adds one factual line reinforcing existing canon: `strategy.yaml` is pinned at `stage: local` (verified against the file in this repo), so nothing here implies a promoted paper or live strategy. Backtest-only, never ran live. - `## What it does` prose is carried over unchanged (relocated, not reworded); a competitive-wording pass for that section is staged separately, not part of this PR. - Topics: added `wranngle` + `active-project` via `gh repo edit --add-topic` (additive only, already applied directly since topics are not part of the branch-protected file surface). ## Test plan - [x] `python3 -m pytest -q` — 126 passed, unchanged - [x] `grep -cP '[—–]' README.md` → 0 - [x] Manual reread against `docs/exec-plans/active/WRANNGLE-README-SYSTEM.md` §3/§4/§9 for verbatim callout/badge/order compliance Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.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
1 participant
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.
Fixes em-dashes and a verified factual mismatch (checked against the actual repo files). Branch-protected, so via PR.