Skip to content

Commit

Permalink
Add badges and table of contents to README.md
Browse files Browse the repository at this point in the history
- 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]>
  • Loading branch information
urasakikeisuke committed May 13, 2024
1 parent 0095127 commit ee138ce
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

0 comments on commit ee138ce

Please sign in to comment.