Skip to content

Open the README with the project logo and badges - #44

Merged
Manushpm8 merged 2 commits into
mainfrom
readme-logo-and-badges
Oct 19, 2026
Merged

Manushpm8 merged 2 commits into
mainfrom
readme-logo-and-badges

Conversation

@Manushpm8

Copy link
Copy Markdown
Collaborator

The README now opens the way the Structured Data Models README does:

  • the cube logo, centred, in its light or dark version to match the reader's GitHub theme;
  • the title centred, with a row of badges in the same NVIDIA green: the PyPI release (read live from PyPI, so it shows v1.0.0 today and follows each release), Python 3.10+, Apache 2.0, contributions welcome, and docs;
  • the one-line summary in bold.

Nothing below the summary changes.

The two logo files are copied byte for byte from docs/source/images/ in the models repository (SHA-256 57d6c38c… light, 1319f2fa… dark), not linked to it, so the header does not break if that repository moves them. Each badge links to something in this repository or to its PyPI page, since there is no published docs site yet.

Checked

  • GitHub renders the branch's README with the light logo in light mode and the dark one in dark mode, and every badge loads.
  • scripts/check_repo_hygiene.py all passes, and the root suite passes (255) against this branch's source.
  • The package READMEs that PyPI shows are separate files and are unchanged.

🤖 Generated with Claude Code

The README now opens the way the models repository's does: the cube logo,
centred, in its light or dark version to match the reader's theme, and a row
of badges for the PyPI release, Python version, licence, contributing guide
and documentation, in the same NVIDIA green.

The two logo files are copied byte for byte from the models repository rather
than linked to it, so the header does not break if that repository moves them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Manush Murali <manushm@nvidia.com>
@Manushpm8
Manushpm8 marked this pull request as ready for review October 19, 2026 18:25
@Manushpm8
Manushpm8 merged commit f2ad8d6 into main Oct 19, 2026
20 checks passed
@Manushpm8
Manushpm8 deleted the readme-logo-and-badges branch October 19, 2026 22:08
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.

3 participants