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

Add badges and table of contents to README.md #7

Merged
merged 1 commit into from
May 14, 2024

Conversation

urasakikeisuke
Copy link
Collaborator

@urasakikeisuke urasakikeisuke commented May 13, 2024

This pull request adds several badges to the top of the README file, showcasing test status, PyPI version, Python version, license, and download statistics. Additionally, it includes a table of contents that
provides quick access to key sections in the README, including Description, Installation, Usage, Contributing, and License.

The changes include:

  • Adding badges for test status, PyPI version, Python version, license, and downloads
  • Creating a table of contents with links to key sections in the README

- Added badges for test, PyPI version, Python version, license, and downloads.
- Added a table of contents with links to various sections in the README.md file.

Signed-off-by: urasakikeisuke <[email protected]>
@urasakikeisuke urasakikeisuke self-assigned this May 13, 2024
Copy link

github-actions bot commented May 13, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/pypcd4
   __init__.py20100% 
   _version.py11282%5–6
   pointcloud2.py591280%87–101
   pypcd4.py3793391%23–24, 107, 135, 188, 349–350, 572–594, 607–648, 658–659, 828, 848–849, 972, 975
TOTAL4514790% 

Tests Skipped Failures Errors Time
60 0 💤 0 ❌ 0 🔥 0.635s ⏱️

@jacoblambert jacoblambert merged commit 2dbfe96 into main May 14, 2024
10 checks passed
@urasakikeisuke urasakikeisuke deleted the docs/readme-badge branch May 14, 2024 02:19
@urasakikeisuke urasakikeisuke added the rd/docs Changes to the documentation label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rd/docs Changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants