Skip to content

docs: add pgraph logo to README - #20

Merged
petercorke merged 1 commit into
docs/standard-readme-layoutfrom
docs/readme-logo
Oct 4, 2026
Merged

petercorke merged 1 commit into
docs/standard-readme-layoutfrom
docs/readme-logo

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Adds a logo to the top of the README. pgraph was the only package in the ecosystem without one.

pgraph logo

The logo shows a snake following a path through a small graph, with its head acting as the arrowhead at the goal vertex. It uses the same style as the RTB/MVTB/bdsim/SMTB snake logos: a grey-to-teal body, yellow eyes and a magenta forked tongue. The "pgraph" wordmark is set in Roboto Medium, as in bdsim's logo.

Changes

  • docs/figs/pgraph_logo.png: the logo, following bdsim's docs/figs/<pkg>_logo.png naming.
  • docs/figs/pgraph_logo.py: regenerates the PNG. It needs Roboto installed and rsvg-convert (librsvg).
  • README.md: the logo goes in the centered header block, as in bdsim and RTB.

Stacked on #4. This PR targets docs/standard-readme-layout because the logo goes inside the centered header that #4 introduces. Merge #4 first. When its branch is deleted, GitHub retargets this PR to main.

Note: the README links the image from main, as the other READMEs do. So the image won't load on the rendered README until this PR is merged to main.

🤖 Generated with Claude Code

pgraph was the only package in the ecosystem without a logo at the top of
its README. The logo is a snake following a path through a small graph, its
head acting as the arrowhead at the goal vertex, in the same style as the
RTB/MVTB/bdsim/SMTB snake logos.

docs/figs/pgraph_logo.py regenerates docs/figs/pgraph_logo.png (needs
Roboto and rsvg-convert).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 2 medium · 1 minor

Alerts:
⚠ 3 issues (≤ 0 issues of at least minor severity)

Results:
3 new issues

Category Results
Security 2 medium
1 minor

View in Codacy

🟢 Metrics 10 complexity · 0 duplication

Metric Results
Complexity 10
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@petercorke
petercorke merged commit b1f2f84 into docs/standard-readme-layout Oct 4, 2026
1 check failed
@petercorke
petercorke deleted the docs/readme-logo branch October 4, 2026 13:38
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