Skip to content

Commit e61be13

Browse files
author
Michael Jeronimo
authored
Add the requirements document (#5)
* Add the first revision of the ROS2 Navigation System requirements document.
1 parent fa9adfa commit e61be13

26 files changed

+343
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Navigation2
22

3-
ROS2 Navigation
3+
ROS2 Navigation System
44

55
# Overview
6-
The ROS2 Navigation system is the central control system for a robot to autonomously move to a given location on a map. Given a current pose, a map and a destination, the system uses sensor input to localize the robot on the map, generates a plan to reach the destination, and outputs commands to drive a robot to that location. It will also autonomously avoid obstacles and re-plan if needed to bypass them.
6+
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.
77

88
# Contributing
9-
Currently we are in the design phase, and are accepting input and requirements. To contribute, see the [design README.md](design/README.md)
9+
We are currently in the requirements analysis phase, and are accepting input and requirements. To contribute, see the [documentation README](doc/README.md).

design/README.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

doc/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ROS2 Navigation System Documentation
2+
This is where the ROS2 Navigation System documentation is being collected and vetted.
3+
4+
# Requirements
5+
See the [requirements document](requirements/requirements.md) for the current list of requirements.
6+
7+
# Contributing
8+
To propose additions or changes to the requirements, please file an issue against the requirements document to initiate a discussion of the topic. Then, once the discussion has completed and the group has agreed to move forward on the item, you can submit a pull request and link to the issue.

doc/images/ros2-logo.png

6.85 KB
Loading
File renamed without changes.
61 KB
Loading
33.3 KB
Loading
203 KB
Binary file not shown.
29.2 KB
Loading
67 KB
Loading

0 commit comments

Comments
 (0)