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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
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