Skip to content

Commit

Permalink
Update README and emphasize MoveIt 2 as default version (#1307)
Browse files Browse the repository at this point in the history
* Update README and emphasize MoveIt 2 as default version

* Update README.md
  • Loading branch information
davetcoleman authored Jun 2, 2022
1 parent fea87c0 commit 025f2e1
Showing 1 changed file with 20 additions and 29 deletions.
49 changes: 20 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="https://moveit.ros.org/assets/logo/moveit2/moveit_logo-black.png" alt="MoveIt 2 Logo" width="200"/>
<img src="https://moveit.ros.org/assets/logo/moveit_logo-black.png" alt="MoveIt Logo" width="200"/>

The MoveIt Motion Planning Framework for **ROS 2**. For ROS 1, see [MoveIt 1](https://github.com/ros-planning/moveit).
The [MoveIt Motion Planning Framework for ROS 2](http://moveit.ros.org).

*Easy-to-use open source robotics manipulation platform for developing commercial applications, prototyping designs, and benchmarking algorithms.*

Expand All @@ -10,51 +10,40 @@ The MoveIt Motion Planning Framework for **ROS 2**. For ROS 1, see [MoveIt 1](ht
[![CI (Rolling and Humble)](https://github.com/ros-planning/moveit2/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/ros-planning/moveit2/actions/workflows/ci.yaml?query=branch%3Amain)
[![Code Coverage](https://codecov.io/gh/ros-planning/moveit2/branch/main/graph/badge.svg?token=W7uHKcY0ly)](https://codecov.io/gh/ros-planning/moveit2)

## General MoveIt Documentation

- [MoveIt Website](http://moveit.ros.org)
- [Tutorials and Documentation](https://ros-planning.github.io/moveit_tutorials/)
- [How to Get Involved](http://moveit.ros.org/about/get_involved/)
- [Future Release Dates](https://moveit.ros.org/#release-versions)

## MoveIt 2 Specific Documentation

- [MoveIt 2 Migration Progress](https://docs.google.com/spreadsheets/d/1aPb3hNP213iPHQIYgcnCYh9cGFUlZmi_06E_9iTSsOI/edit?usp=sharing)
- [MoveIt 2 Migration Guidelines](doc/MIGRATION_GUIDE.md)
- [MoveIt 2 Development Roadmap](https://moveit.ros.org/documentation/contributing/roadmap/)

## Source Build
## Getting Started

See [MoveIt 2 Source Build - Linux](https://moveit.ros.org/install-moveit2/source/)
See our extensive [Tutorials and Documentation](https://moveit.picknik.ai/)

## Getting Started
## Install

We've prepared a simple demo setup that you can use for quickly spinning up a simulated robot environment with MoveItCpp.
See the [MoveItCpp Tutorial](https://moveit.picknik.ai/foxy/doc/moveit_cpp/moveitcpp_tutorial.html) for further instructions and information.
- [Binary Install](https://moveit.ros.org/install-moveit2/binary/)
- [Source Build](https://moveit.ros.org/install-moveit2/source/)

The [Move Group C++ Interface](https://moveit.picknik.ai/foxy/doc/move_group_interface/move_group_interface_tutorial.html) provides a simple launch file for running a MoveGroup setup.
You can test it using the MotionPlanning display in RViz or by implementing your own MoveGroupInterface application.
## More Info

## Having Doxygen Reference Locally
See [How To Generate API Doxygen Reference Locally](https://moveit.picknik.ai/main/doc/how_to_guides/how_to_generate_api_doxygen_locally.html)
- [How to Get Involved](http://moveit.ros.org/about/get_involved/)
- [Development Roadmap](https://moveit.ros.org/documentation/contributing/roadmap/)
- [Future Release Dates](https://moveit.ros.org/#release-versions)
- [MoveIt 2 Migration Guidelines](doc/MIGRATION_GUIDE.md)
- [MoveIt 2 Migration Progress](https://docs.google.com/spreadsheets/d/1aPb3hNP213iPHQIYgcnCYh9cGFUlZmi_06E_9iTSsOI/edit?usp=sharing)

## Supporters

This open source project is maintained by supporters from around the world — see [MoveIt maintainers](https://moveit.ros.org/about/). Special thanks to contributor from Intel and Open Robotics.
This open source project is maintained by supporters from around the world — see our [MoveIt Maintainers and Core Contributors](https://moveit.ros.org/about/).

<a href="https://picknik.ai/">
<img src="https://picknik.ai/assets/images/logo.jpg" width="168">
</a>

[PickNik Inc.](https://picknik.ai/) is leading and organizing the development of MoveIt 2.
[PickNik Inc](https://picknik.ai/) is leading the development of MoveIt.
If you would like to support this project, please contact [email protected]

<a href="http://rosin-project.eu">
<img src="http://rosin-project.eu/wp-content/uploads/rosin_ack_logo_wide.png"
alt="rosin_logo" height="60" >
</a>

The port to ROS 2 is supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components.
The port to ROS 2 was supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components.
More information: <a href="http://rosin-project.eu">rosin-project.eu</a>

<img src="http://rosin-project.eu/wp-content/uploads/rosin_eu_flag.jpg"
Expand All @@ -63,9 +52,11 @@ More information: <a href="http://rosin-project.eu">rosin-project.eu</a>
This project has received funding from the European Union’s Horizon 2020
research and innovation programme under grant agreement no. 732287.

## Generate API Doxygen Documentation
See [How To Generate API Doxygen Reference Locally](https://moveit.picknik.ai/main/doc/how_to_guides/how_to_generate_api_doxygen_locally.html)

# ROS2 Buildfarm
| MoveIt 2 Package | Foxy Binary | Galactic Binary | Rolling Binary | Humble Binary |
# Buildfarm
| MoveIt Package | Foxy Binary | Galactic Binary | Rolling Binary | Humble Binary |
|:---:|:---:|:---:|:---:|:---:|
| geometric_shapes | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Fbin_uF64__geometric_shapes__ubuntu_focal_amd64__binary)](https://build.ros2.org/job/Fbin_uF64__geometric_shapes__ubuntu_focal_amd64__binary) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Gbin_uF64__geometric_shapes__ubuntu_focal_amd64__binary)](https://build.ros2.org/job/Gbin_uF64__geometric_shapes__ubuntu_focal_amd64__binary) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Rbin_uJ64__geometric_shapes__ubuntu_jammy_amd64__binary)](https://build.ros2.org/job/Rbin_uJ64__geometric_shapes__ubuntu_jammy_amd64__binary) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Hbin_uJ64__geometric_shapes__ubuntu_jammy_amd64__binary)](https://build.ros2.org/job/Hbin_uJ64__geometric_shapes__ubuntu_jammy_amd64__binary) |
| moveit | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Fbin_uF64__moveit__ubuntu_focal_amd64__binary)](https://build.ros2.org/job/Fbin_uF64__moveit__ubuntu_focal_amd64__binary) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Gbin_uF64__moveit__ubuntu_focal_amd64__binary)](https://build.ros2.org/job/Gbin_uF64__moveit__ubuntu_focal_amd64__binary) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Rbin_uJ64__moveit__ubuntu_jammy_amd64__binary)](https://build.ros2.org/job/Rbin_uJ64__moveit__ubuntu_jammy_amd64__binary) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Hbin_uJ64__moveit__ubuntu_jammy_amd64__binary)](https://build.ros2.org/job/Hbin_uJ64__moveit__ubuntu_jammy_amd64__binary) |
Expand Down

0 comments on commit 025f2e1

Please sign in to comment.