diff --git a/README.md b/README.md index 908cf98972388008a8424227f8eb404a1c2d60b7..06110bcbf403c6da73da18395894277c7d175d46 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ -# Navigation2 +# Navigation2 Stack -ROS2 Navigation System -[](https://circleci.com/gh/ros-planning/navigation2/tree/master) CircleCI +| Builder | Status | +|----------------------|-------------------------| +| CircleCI | [](https://circleci.com/gh/ros-planning/navigation2/tree/master) | +| DockerHub | [](https://hub.docker.com/r/rosplanning/navigation2) | +| ROS2 Build Farm | [](http://build.ros2.org/job/Cdev__navigation2__ubuntu_bionic_amd64/) | +| Code Coverage | [](https://codecov.io/gh/ros-planning/navigation2) | -[](https://hub.docker.com/r/rosplanning/navigation2) DockerHub - -[](http://build.ros2.org/job/Cdev__navigation2__ubuntu_bionic_amd64/) ROS Build Farm - -[](https://codecov.io/gh/ros-planning/navigation2) # Overview The ROS 2 Navigation System is the control system that enables a robot to autonomously reach a goal state, such as a specific position and orientation relative to a specific map. Given a current pose, a map, and a goal, such as a destination pose, the navigation system generates a plan to reach the goal, and outputs commands to autonomously drive the robot, respecting any safety constraints and avoiding obstacles encountered along the way. @@ -18,6 +17,9 @@ The ROS 2 Navigation System is the control system that enables a robot to autono # Documentation For detailed instructions on how to install and run the examples, please visit our [documentation site](https://ros-planning.github.io/navigation2/). +# API Documentation +Run `doxygen` in the root of this repository. It will generate a `/doc/*` directory containing the documentation. Entrypoint in a browser is index.html. + # Contributing [Contributions are welcome!](doc/README.md#contributing). For more information, please review our [contribution guidelines](https://ros-planning.github.io/navigation2/contribute/contribute_guidelines.html).