From be7f39f1034964ab76553450096b154110c87b85 Mon Sep 17 00:00:00 2001 From: Matthew Hansen Date: Mon, 11 Jun 2018 09:43:25 -0700 Subject: [PATCH 1/2] Added Overview section to README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9a54b46ea4..9b8068212c 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,8 @@ ROS2 Navigation +# Overview +The ROS2 Navigation system is the central control system for a robot to autonomously move to a given location on a map. Given 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. + # Contributing Currently we are in the design phase, and are accepting input and requirements. To contribute, see the [design README.md](design/README.md) From 110c0835d42c5bdfabe6946fe4ae1c20bacc5fd3 Mon Sep 17 00:00:00 2001 From: Matt Hansen Date: Tue, 12 Jun 2018 13:27:43 -0700 Subject: [PATCH 2/2] Updated README to add current pose input --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b8068212c..40ac5df422 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ROS2 Navigation # Overview -The ROS2 Navigation system is the central control system for a robot to autonomously move to a given location on a map. Given 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. +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. # Contributing Currently we are in the design phase, and are accepting input and requirements. To contribute, see the [design README.md](design/README.md)