Skip to content

Redesign the README - #1035

Merged
EHxuban11 merged 3 commits into
devfrom
docs/readme-redesign
Nov 11, 2026
Merged

EHxuban11 merged 3 commits into
devfrom
docs/readme-redesign

Conversation

@EHxuban11

@EHxuban11 EHxuban11 commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

What: README redesign for the English landing page.
Why: shorter page with a banner, task-first sections and links to the guides.

  • New banner (docs/readme/banner.png, source scripts/readme/banner.html) and a one-line description
  • Sections are now Install, Train, Inference, Export, Documentation, Complete list of models, Follow us, Contributors, Sponsors, License
  • Train, Inference and Export link to their guides on libreyolo.com
  • Model table: 120 model names link to their docs page; 27 without a page stay plain text
  • Removed "Why LibreYOLO", the accuracy chart and "Beyond detection" from the English README
  • Sponsors copy rewritten, supporters shown with GitHub avatars; SPONSORS.md touched by the earlier commit on this branch
  • Optional extras: paddle added to the extras left out of all, matching pyproject.toml
  • Kept the Hugging Face mirror note from Honour HF_ENDPOINT and hint at a mirror when huggingface.co is unreachable #1033 under Install

Check: rendered README on the branch, light and dark theme.
Not verified: unit tests were not run locally (no pytest in the environment); README.zh-CN.md has the banner and the earlier section order but does not yet mirror the latest English changes (it still has the chart and the removed sections); the LibreYOLO("LibreYOLO/LibreRFDETRn") example was not executed; the Greptile CLI pre-review had not finished when this PR was opened.
Opened by an agent.

Code provenance

Original content written for this PR: README text, a banner image rendered from first-party HTML/CSS using the project's own logo mark, and a standard-library chart script from the earlier commit on this branch. The banner text is set in Outfit and JetBrains Mono (both SIL Open Font License) and shipped only as a rendered PNG. No third-party code ported, adapted, or introduced; no GPL/AGPL/LGPL/non-commercial/unknown-license material involved.

RetriggerView in GreptileConfidence Score: 4/5

The PR appears safe to merge, with non-blocking fixes for example prerequisites and chart refresh checks.

Fix All in CursorFindings

  1. P2 The example needs extra packages ▶
  2. P2 Chart refresh ignores image count ▶

Summary

Redesigns the English landing page with a banner, task-first examples, model links, and supporter avatars. Also updates the Chinese README and adds a chart generator.

  • Training, inference, and export examples now lead readers to their matching guides.
  • The model catalog groups models by task and links available documentation.
  • The README now leads with the install command and a short project introduction.
  • The Chinese README pairs its longer showcase with a theme-aware benchmark chart.
  • Community and sponsor sections now show direct ways to follow and support LibreYOLO.

Reviews (1) · Last reviewed commit: "Add README banner and simplify sections" · Reviewed by Greptile

@EHxuban11
EHxuban11 merged commit d39950e into dev Nov 11, 2026
12 checks passed
Comment thread README.md
result = model(SAMPLE_IMAGE, save=True)
```

Load any model straight from Hugging Face by its repo name: `LibreYOLO("LibreYOLO/LibreRFDETRn")`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 The example needs extra packages

After the documented pip install libreyolo, this example fails because repo-name loading needs huggingface_hub. The English RF-DETR example also needs transformers. Add pip install "libreyolo[hf,rfdetr]" beside this example and the hf prerequisite beside the Chinese example so readers can run them without missing-package errors.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Fix in Cursor Fix in Codex

Comment on lines +94 to +95
and r["dataset"]["id"] == "coco2017"
and r["model"]["id"] in wanted

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Chart refresh ignores image count

refresh() accepts results without checking the advertised 500-image subset. If a replacement result for the same model and device uses a different image count, the README will still label it as 500 images. Reject rows whose dataset.num_images is not 500 before writing the CSV.

Suggested change
and r["dataset"]["id"] == "coco2017"
and r["model"]["id"] in wanted
and r["dataset"]["id"] == "coco2017"
and r["dataset"]["num_images"] == 500
and r["model"]["id"] in wanted

Fix in Cursor Fix in Codex

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