Skip to content

Commit

Permalink
Add command to launch the driver in the top level readme
Browse files Browse the repository at this point in the history
Signed-off-by: Katie Hughes <[email protected]>
  • Loading branch information
Katie Hughes committed Jan 14, 2025
1 parent 8e9d48d commit 081d826
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:=<path/to/config.yaml>] [spot_name:=<Spot Name>] [launch_rviz:=<True|False>] [launch_image_publishers:=<True|False>] [publish_point_clouds:=<True|False>] [uncompress_images:=<True|False>] [publish_compressed_images:=<True|False>] [stitch_front_images:=<True|False>]
```
* [`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.
Expand Down

0 comments on commit 081d826

Please sign in to comment.