Skip to content
Snippets Groups Projects
Unverified Commit f409ba18 authored by Carlos A. Orduno's avatar Carlos A. Orduno Committed by GitHub
Browse files

Minor updates to documentation paths in READMEs (#1295)

parent fa2ce51f
No related branches found
No related tags found
No related merge requests found
...@@ -17,14 +17,17 @@ ROS2 Navigation System ...@@ -17,14 +17,17 @@ ROS2 Navigation System
# Overview # 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. 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.
# Documentation
For detailed instructions on how to install and run the examples, please visit our [documentation site](https://ros-planning.github.io/navigation2/).
# Contributing # Contributing
We are currently in the pre-release development phase, contributions are welcome. To contribute, see the [documentation README](doc/README.md). [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).
# Building the source # Building the source
For instructions on how to download and build this repo, see the [BUILD.md](doc/BUILD.md) file. For instructions on how to download and build this repo, see the [BUILD.md](doc/BUILD.md) file.
# Creating a docker image # Creating a docker image
To build an image from the Dockerfile in the navigation2 folder: To build an image from the Dockerfile in the navigation2 folder:
First, clone the repo to your local system (or see Building the source above) First, clone the repo to your local system (or see Building the source above)
``` ```
sudo docker build -t nav2/latest . sudo docker build -t nav2/latest .
......
# Project Documentation # Navigation2 Documentation
This folder holds the source and configuration files used to generate the This folder holds the source and configuration files used to generate the
Project documentation web site. [Navigation2 documentation](https://ros-planning.github.io/navigation2/) web site.
Learn how to setup and generate documentation by reading the howtos Learn how to setup and generate documentation by reading the [howtos](https://ros-planning.github.io/navigation2/howtos/index.html).
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment