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

Jump to bottom

Add list of distros branches to README #297

Closed
wants to merge 1 commit into from
Closed

Add list of distros branches to README #297

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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,21 @@ ROS 2 examples
==============

To see some of these examples in use, visit the ROS 2 Tutorials page: https://index.ros.org/doc/ros2/Tutorials/

Branches
--------

This repo targets different ROS distributions on different branches.
You must use the branch matching the ROS distro being used when building from source.

Ony [non-EOL ROS distributions](https://index.ros.org/doc/ros2/Releases/) are supported.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a thought, but it might be a good idea to quickly elaborate/explain what "are supported" means here, especially since the table below lists both supported and unsupported distros.

also, Ony -> Only

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, instead of a negative ("non-EOL"), I'd suggest the positive ("currently supported"). So maybe rewrite the sentence something like:

Suggested change
Ony [non-EOL ROS distributions](https://index.ros.org/doc/ros2/Releases/) are supported.
Changes are only accepted for [currently supported ROS distributions](https://index.ros.org/doc/ros2/Releases/).


| ROS Distro | Branch |
|------------|----------|
| Rolling | master |
| Foxy | foxy |
| Eloquent | eloquent |
| Dashing | dashing |
| Crystal | crystal |
| Bouncy | bouncy |
| Ardent | ardent |