Skip to content

Commit

Permalink
Merge pull request #7 from MapIV/docs/readme-badge
Browse files Browse the repository at this point in the history
Add badges and table of contents to README.md
  • Loading branch information
jacoblambert authored May 14, 2024
2 parents 0095127 + ee138ce commit 2dbfe96
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# pypcd4

[![Test](https://github.com/MapIV/pypcd4/actions/workflows/test.yaml/badge.svg)](https://github.com/MapIV/pypcd4/actions/workflows/test.yaml)
![PyPI - Version](https://img.shields.io/pypi/v/pypcd4)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypcd4)
![GitHub License](https://img.shields.io/github/license/MapIV/pypcd4)
![PyPI - Downloads](https://img.shields.io/pypi/dm/pypcd4)

## Table of Contents

* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
* [Importing pypcd4](#getting-started)
* [Loading PCD File](#working-with-pcd-files)
* [Converting to NumPy Array](#converting-between-pointcloud-and-numpy-array)
* [Converting to ROS Message](#working-with-ros-pointcloud2-messages)
* [Concatenating PointClouds](#concatenating-two-pointclouds)
* [Filtering PointClouds](#filtering-a-pointcloud)
* [Saving Your Work](#saving-your-work)
* [Contributing](#contributing)
* [License](#license)

## Description

pypcd4 is a modern reimagining of the original [pypcd](https://github.com/dimatura/pypcd) library,
Expand Down

5 comments on commit 2dbfe96

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.627s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.637s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.626s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.639s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ⏱️

Please sign in to comment.