From 14ca43011a84066de72defc64f87df91cdb5e349 Mon Sep 17 00:00:00 2001 From: Alberto Tudela Date: Fri, 19 Jul 2024 13:16:23 +0200 Subject: [PATCH] Fix readmes Signed-off-by: Alberto Tudela --- README.md | 4 ++-- scitos2_modules/README.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 51b43f2..afdc7a3 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ `scitos2` is a ROS 2 stack designed for Metralabs robots that utilize the MIRA framework, including models such as SCITOS, TORY, MORPHIA, etc. This stack comprises several packages, each serving a unique purpose: * [scitos2_behavior_tree]: This package contains behavior tree nodes that extend your robot's functionalities, such as emergency stop, reset motor stop, etc. - * [scito2_charing_dock]: This package contains the implementation of the charging dock plugin for the SCITOS and TORY robots from MetraLabs using the opennav_docking server. + * [scito2_charging_dock]: This package contains the implementation of the charging dock plugin for the SCITOS and TORY robots from MetraLabs using the opennav_docking server. * [scitos2_common]: This package provides common functionalities for the scitos2 stack. * [scitos2_core]: This package provides the abstract interface (virtual base classes) for the Scitos Modules. * [scitos2_mira]: This is the main node that interfaces with the MIRA framework. @@ -38,7 +38,7 @@ colcon build --symlink-install ``` [scitos2_behavior_tree]: /scitos2_behavior_tree -[scito2_charing_dock]: /scitos2_charging_dock +[scito2_charging_dock]: /scitos2_charging_dock [scitos2_common]: /scitos2_common [scitos2_core]: /scitos2_core [scitos2_mira]: /scitos2_mira diff --git a/scitos2_modules/README.md b/scitos2_modules/README.md index 6dc04c3..c280496 100644 --- a/scitos2_modules/README.md +++ b/scitos2_modules/README.md @@ -118,7 +118,7 @@ The Drive module controls the robot's motors, handling velocity commands, odomet * **`emergency_stop`** ([scitos2_msgs/EmergencyStop]) - This service stops the robot. It is equivalent to the bumper being pressed - the motor stop is engaged, and can be reset with /reset_motorstop. + This service stops the robot. It is equivalent to the bumper being pressed - the motor stop is engaged, and can be reset with `/reset_motorstop`. * **`enable_rfid`** ([scitos2_msgs/EnableRfid]) @@ -150,11 +150,11 @@ The Drive module controls the robot's motors, handling velocity commands, odomet Specifies the name of the base frame of the robot. -* ** `odom_frame`** (string, default: odom) +* **`odom_frame`** (string, default: odom) Specifies the name of the odometry frame when publishing the TF. -* ** `odom_topic`** (string, default: odom) +* **`odom_topic`** (string, default: odom) Specifies the name of the odometry topic.