Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Improve READMEs and pypi docs for binaries #214

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

joeyparrish
Copy link
Member

The binary package on pypi has almost no information. This adds a more detailed README to make the pypi landing page more explanatory.

This also improves the main README to mention the binary package. It is strongly recommended, and should be mentioned in the brief instructions on the main package README.

Classified as a "fix" only so that the release workflow will trigger, so that we can update the docs on pypi with a new release.

The binary package on pypi has almost no information.  This adds a more detailed README to make the pypi landing page more explanatory.

This also improves the main README to mention the binary package.  It is strongly recommended, and should be mentioned in the brief instructions on the main package README.

Classified as a "fix" only so that the release workflow will trigger, so that we can update the docs on pypi with a new release.
@joeyparrish joeyparrish merged commit 4dd6fa4 into shaka-project:main Nov 12, 2024
21 checks passed
@joeyparrish joeyparrish deleted the binaries-in-readme branch November 12, 2024 18:39
@github-actions github-actions bot added the status: archived Archived and locked; will not be updated label Jan 11, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: archived Archived and locked; will not be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants