Skip to content

Commit

Permalink
rosbag2_storage_mcap: update readme after move
Browse files Browse the repository at this point in the history
Signed-off-by: James Smith <[email protected]>
  • Loading branch information
james-rms committed Nov 24, 2022
1 parent 437ae3c commit 17a406e
Showing 1 changed file with 9 additions and 21 deletions.
30 changes: 9 additions & 21 deletions rosbag2_storage_mcap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@

This package provides a [storage plugin](https://github.com/ros2/rosbag2#storage-format-plugin-architecture) for rosbag2 which extends it with support for the [MCAP](https://mcap.dev) file format.

[![ROS Foxy version](https://img.shields.io/ros/v/foxy/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros-tooling-rosbag2_storage_mcap/#foxy)
[![ROS Galactic version](https://img.shields.io/ros/v/galactic/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros-tooling-rosbag2_storage_mcap/#galactic)
[![ROS Humble version](https://img.shields.io/ros/v/humble/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros-tooling-rosbag2_storage_mcap/#humble)
[![ROS Rolling version](https://img.shields.io/ros/v/rolling/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros-tooling-rosbag2_storage_mcap/#rolling)

[![ROS Foxy version](https://img.shields.io/ros/v/foxy/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros2-rosbag2/#foxy)
[![ROS Galactic version](https://img.shields.io/ros/v/galactic/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros2-rosbag2/#galactic)
[![ROS Humble version](https://img.shields.io/ros/v/humble/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros2-rosbag2/#humble)
[![ROS Rolling version](https://img.shields.io/ros/v/rolling/rosbag2_storage_mcap)](https://index.ros.org/p/rosbag2_storage_mcap/github-ros2-rosbag2/#rolling)

## ⚠️ Move from `ros-tooling` organization

This package was recently merged into [https://github.com/ros2/rosbag2] from [https://github.com/ros-tooling/rosbag2_storage_mcap]. To view historical pull requests and git history of this package, check [here](https://github.com/ros-tooling/rosbag2_storage_mcap/commits/main).


## Installation
Expand Down Expand Up @@ -136,23 +141,6 @@ compressionLevel: "Slowest"
chunkSize: 4194304 # 4 * 1024 * 1024
```

## Development

To build `rosbag2_storage_mcap` from source:

```bash
$ source /opt/ros/[distro]/setup.bash
$ git clone https://github.com/ros-tooling/rosbag2_storage_mcap.git
$ cd rosbag2_storage_mcap
$ colcon build
# In another shell:
$ source /opt/ros/[distro]/setup.bash
$ cd rosbag2_storage_mcap
$ source install/local_setup.bash
$ ros2 bag info -s mcap path/to/your_recording.mcap
```

### ROS 2 Distro maintenance

Whenever a ROS 2 distribution reaches EOL, search for comments marked COMPATIBILITY - which may no longer be needed when no new releases will be made for that distro.

0 comments on commit 17a406e

Please sign in to comment.