From c386d6814156b38f97098302358a3477c526bbe6 Mon Sep 17 00:00:00 2001 From: Guanyang Luo Date: Sat, 4 Jul 2020 12:09:52 -0700 Subject: [PATCH] Clarify "Getting Started" launch file change The added note should help new users or ROS 2 Dashing users avoid issues with the "Getting Started" launch file, and also explain preference for Eloquent and later. ros-planning/navigation2#1607 ros-planning/navigation2#1663 ros-planning/navigation.ros.org#9 ros-planning/navigation.ros.org#36 --- getting_started/index.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/getting_started/index.rst b/getting_started/index.rst index 20277be54..927644f03 100644 --- a/getting_started/index.rst +++ b/getting_started/index.rst @@ -51,6 +51,14 @@ Running the Example .. code-block:: bash ros2 launch nav2_bringup tb3_simulation_launch.py + + .. note:: + + For ``ROS 2 Dashing Diademata`` or earlier, use + ``nav2_simulation_launch.py``. + However, it is highly recommended to use Navigation 2 with ``ROS 2 + Eloquent Elusor`` or later for **massively** improved stablity and + feature completeness. This launch file will launch Navigation2 with the AMCL localizer in the ``turtlebot3_world`` world.