diff --git a/rosbag2_storage_mcap/README.md b/rosbag2_storage_mcap/README.md index 1755f8fdc..17fa209d2 100644 --- a/rosbag2_storage_mcap/README.md +++ b/rosbag2_storage_mcap/README.md @@ -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](ros2/rosbag2) from [https://github.com/ros-tooling/rosbag2_storage_mcap](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 @@ -13,8 +18,8 @@ This package provides a [storage plugin](https://github.com/ros2/rosbag2#storage rosbag2_storage_mcap is available as part of the [current ROS 2 distributions](https://docs.ros.org/en/rolling/Releases.html). On Ubuntu, after following the [ROS 2 installation instructions](https://docs.ros.org/en/humble/Installation.html), you can use: ```bash -# Replace "humble" with your ROS distro (`echo $ROS_DISTRO`) -$ sudo apt install ros-humble-rosbag2-storage-mcap +# Replace "rolling" with your ROS distro (`echo $ROS_DISTRO`) +$ sudo apt install ros-rolling-rosbag2-storage-mcap ``` ## Usage @@ -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.