Skip to content

docs: add package logo to README - #46

Merged
Zikithezikit merged 1 commit into
mainfrom
feature/adding-logo
Nov 12, 2026
Merged

Zikithezikit merged 1 commit into
mainfrom
feature/adding-logo

Conversation

@Zikithezikit

@Zikithezikit Zikithezikit commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

Adds the PyKyber lockup logo to the repo and shows it centered (400px wide) at the top of the README.

  • docs/assets/logo.png and docs/assets/logo-mono.png, copied from the 4x PNG exports.
  • README uses a relative path (docs/assets/logo.png), so it renders on GitHub. PyPI cannot resolve relative paths, so the logo will not show on the PyPI project page; switching to an absolute raw.githubusercontent.com URL fixes that once the file is on the default branch.
  • CHANGELOG line under Unreleased.

No code or package behavior changes. docs/ is plain Markdown (no mkdocs or sphinx), so there is no docs logo or favicon to set. The images are not in the wheel; I did not build the wheel or sdist to confirm, this is from reading pyproject.toml.

Add the PyKyber lockup (color and mono) under docs/assets and show the
color version at the top of the README. The images stay out of the wheel.
@Zikithezikit
Zikithezikit merged commit 213e31d into main Nov 12, 2026
45 checks passed
@Zikithezikit
Zikithezikit deleted the feature/adding-logo branch November 12, 2026 06:56
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