docs: restructure README top section to standard ecosystem layout - #4
Open
petercorke wants to merge 1 commit into
Open
docs: restructure README top section to standard ecosystem layout#4petercorke wants to merge 1 commit into
petercorke wants to merge 1 commit into
Conversation
Follows the layout documented in rvc-ecosystem's README.md (tagline, quick links, badges in Status & Project Health / Ecosystem & Dependencies groups) already used by RTB, MVTB, bdsim, and sphinx-pyrunblock. Also fixes two stale details along the way: - The license badge pointed at img.shields.io/github/license/Naereen/StrapDown.js.svg, a static badge for an unrelated repo, not pgraph-python's own MIT license. - The downloads badge used shields.io's pypi/dw endpoint, which the ecosystem doc notes is subject to rate limiting; switched to pepy.tech. Adds powered-by badges for NumPy, SciPy, and Matplotlib -- real dependencies that weren't previously badged, matching the doc's "major packages used" guidance.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4 +/- ##
=======================================
Coverage 82.28% 82.28%
=======================================
Files 2 2
Lines 717 717
=======================================
Hits 590 590
Misses 127 127 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Follows the layout documented in rvc-ecosystem's README.md (tagline, quick links, badges grouped into Status & Project Health / Ecosystem & Dependencies), matching RTB/MVTB/bdsim/sphinx-pyrunblock. Also fixes a stale license badge (was pointing at an unrelated repo's static badge), switches the downloads badge to pepy.tech per the ecosystem doc's note on rate limiting, and adds powered-by badges for NumPy/SciPy/Matplotlib, real dependencies that weren't previously badged.