From 081d8262281ff4ce6344f8c34beb9acb63a9a1f2 Mon Sep 17 00:00:00 2001 From: Katie Hughes Date: Tue, 14 Jan 2025 10:33:40 -0500 Subject: [PATCH] Add command to launch the driver in the top level readme Signed-off-by: Katie Hughes --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 330aeab0..18f40d9f 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,10 @@ Further documentation on how each of these packages can be used can be found in * [`spot_description`](spot_description): contains the URDF of Spot and some simple launchfiles for visualization. * [`spot_driver`](spot_driver): Core driver for operating Spot. This contains all of the necessary topics, services, and actions for controlling Spot and receiving state information over ROS 2. + * The driver can be launched via the following command after building and sourcing your workspace. More details can be found on the [`spot_driver` README](spot_driver/README.md). + ``` + ros2 launch spot_driver spot_driver.launch.py [config_file:=] [spot_name:=] [launch_rviz:=] [launch_image_publishers:=] [publish_point_clouds:=] [uncompress_images:=] [publish_compressed_images:=] [stitch_front_images:=] + ``` * [`spot_examples`](spot_examples): Examples of how to control Spot via the Spot driver. * [`spot_msgs`](spot_msgs): Custom messages, services, and interfaces relevant for operating Spot.