Skip to content

Commit

Permalink
Improving README appearance
Browse files Browse the repository at this point in the history
  • Loading branch information
danthony06 committed Dec 9, 2024
1 parent 0750c1c commit 3c69349
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
marti\_messages ![CI](https://github.com/swri-robotics/marti_messages/workflows/CI/badge.svg) ![CI](https://github.com/swri-robotics/marti_messages/workflows/CI/badge.svg?branch=dashing-devel)
marti\_messages
=============================================================================================

This repository provides various messages created at [Southwest Reseach Institute](http://www.swri.org)'s [Intelligent Systems](https://www.swri.org/technical-divisions/intelligent-systems)'s division for working with [Robot Operating System(ROS)](http://www.ros.org).

The `master` branch provides support for ROS Noetic; the `ros2-devel` branch provides support for current ROS 2 distributions.

Build Status
--------
ROS 2 Distro | Branch | Build status | Released packages
:----------: | :----: | :----------: | :---------------:
**Humble** | [`humble`](https://github.com/swri-robotics/marti_messages/tree/ros2-devel) | [![CI](https://github.com/swri-robotics/marti_messages/workflows/CI/badge.svg?branch=ros2-devel)](https://github.com/swri-robotics/marti_messages/blob/ros2-devel/.github/workflows/main.yml?branch=ros2-devel) <br /> [![ROS2 Build Farm](http://build.ros2.org/buildStatus/icon?job=Hdev__marti_messages__ubuntu_jammy_amd64)](https://build.ros2.org/job/Hdev__marti_messages__ubuntu_jammy_amd64/) | [marti-can-msgs](https://index.ros.org/p/marti_can_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-common-msgs](https://index.ros.org/p/marti_common_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-dbw-msgs](https://index.ros.org/p/marti_dbw_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-introspection-msgs](https://index.ros.org/p/marti_introspection_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-nav-msgs](https://index.ros.org/p/marti_nav_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-perception-msgs](https://index.ros.org/p/marti_perception_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-sensor-msgs](https://index.ros.org/p/marti_sensor_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-status-msgs](https://index.ros.org/p/marti_status_msgs/github-swri-robotics-marti_messages/#humble) <br /> [marti-visualization-msgs](https://index.ros.org/p/marti_visualization_msgs/github-swri-robotics-marti_messages/#humble)
**Jazzy** | [`jazzy`](https://github.com/swri-robotics/marti_messages/tree/ros2-devel) | [![CI](https://github.com/swri-robotics/marti_messages/workflows/CI/badge.svg?branch=ros2-devel)](https://github.com/swri-robotics/marti_messages/blob/ros2-devel/.github/workflows/main.yml?branch=ros2-devel) <br /> [![ROS2 Build Farm](http://build.ros2.org/buildStatus/icon?job=Hdev__marti_messages__ubuntu_jammy_amd64)](https://build.ros2.org/job/Hdev__marti_messages__ubuntu_jammy_amd64/) | [marti-can-msgs](https://index.ros.org/p/marti_can_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-common-msgs](https://index.ros.org/p/marti_common_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-dbw-msgs](https://index.ros.org/p/marti_dbw_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-introspection-msgs](https://index.ros.org/p/marti_introspection_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-nav-msgs](https://index.ros.org/p/marti_nav_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-perception-msgs](https://index.ros.org/p/marti_perception_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-sensor-msgs](https://index.ros.org/p/marti_sensor_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-status-msgs](https://index.ros.org/p/marti_status_msgs/github-swri-robotics-marti_messages/#jazzy) <br /> [marti-visualization-msgs](https://index.ros.org/p/marti_visualization_msgs/github-swri-robotics-marti_messages/#jazzy)
**Rolling** | [`rolling`](https://github.com/swri-robotics/marti_messages/tree/ros2-devel) | [![CI](https://github.com/swri-robotics/marti_messages/workflows/CI/badge.svg?branch=ros2-devel)](https://github.com/swri-robotics/marti_messages/blob/ros2-devel/.github/workflows/main.yml?branch=ros2-devel) <br /> [![ROS2 Build Farm](http://build.ros2.org/buildStatus/icon?job=Hdev__marti_messages__ubuntu_jammy_amd64)](https://build.ros2.org/job/Hdev__marti_messages__ubuntu_jammy_amd64/) | [marti-can-msgs](https://index.ros.org/p/marti_can_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-common-msgs](https://index.ros.org/p/marti_common_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-dbw-msgs](https://index.ros.org/p/marti_dbw_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-introspection-msgs](https://index.ros.org/p/marti_introspection_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-nav-msgs](https://index.ros.org/p/marti_nav_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-perception-msgs](https://index.ros.org/p/marti_perception_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-sensor-msgs](https://index.ros.org/p/marti_sensor_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-status-msgs](https://index.ros.org/p/marti_status_msgs/github-swri-robotics-marti_messages/#rolling) <br /> [marti-visualization-msgs](https://index.ros.org/p/marti_visualization_msgs/github-swri-robotics-marti_messages/#rolling)

Installation
------------

Expand All @@ -13,7 +21,7 @@ If you have installed ROS, you can install any of the packages in this repositor
sudo apt-get install ros-${ROS_DISTRO}-<package>


Building From Source (ROS Dashing, Eloquent)
Building From Source
-------------------------------------------------------

These directions assume you have already set up a colcon workspace
Expand All @@ -22,7 +30,7 @@ These directions assume you have already set up a colcon workspace

If you're using wstool, add this repository to your workspace:

git clone -b dashing-devel https://github.com/swri-robotics/marti_messages.git
git clone -b ros2-devel https://github.com/swri-robotics/marti_messages.git

### Installing dependencies and building

Expand Down

0 comments on commit 3c69349

Please sign in to comment.