docs: add project logo to README - #16
Merged
Merged
Conversation
Adds assets/logo.svg and shows it centered at the top of the README, above the project title and badges. The source SVG carried width and height but no viewBox, which makes browsers clip it when it is scaled down inside an img tag. A viewBox of 0 0 1280 640 was added so it scales cleanly. The artwork itself is unchanged. The mark has a transparent background and no white plate, so it reads on both the light and dark GitHub themes.
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.
Adds a project logo and shows it at the top of the README.
assets/logo.svg(2:1 landscape mark, transparent background, no white plate).st-rsuitetitle and badges.raw.githubusercontent.comURL onmainrather than a relative path, because this README is also the PyPI long description and relative paths break there. The image will 404 in this PR preview until the branch merges, which is expected.One note on the SVG: the generated file had
widthandheightbut noviewBox, so browsers clip it instead of scaling it when it is rendered smaller inside an image tag. AviewBoxof0 0 1280 640was added to the root element. The paths and colours are untouched.Docs only. Prefixed
docs:so semantic-release does not cut a version.