Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
Signed-off-by: Michel Hidalgo <[email protected]>
  • Loading branch information
mhidalgo-bdai committed Dec 2, 2024
1 parent b4dcb83 commit 20b3872
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ Develop applications and payloads for Spot using the Boston Dynamics Spot C++ SD

The C++ SDK consists of:

- [C++ client library](docs/cpp/README.md). Applications using the C++ library can control Spot and read sensor and health information from Spot. A variety of example programs and a QuickStart guide are also included.
- [Spot C++ SDK Repository](https://github.com/boston-dynamics/spot-cpp-sdk). The GitHub repo where all of the Spot C++ SDK code is hosted.
- [C++ client library](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2/docs/cpp). Applications using the C++ library can control Spot and read sensor and health information from Spot. A variety of example programs and a QuickStart guide are also included.
- [Spot C++ SDK repository **fork***](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2). The GitHub repository where all of the Spot C++ SDK code patched for ROS 2 release is hosted.

The official Spot SDK documentation also contains information relevant to the C++ SDK:

- [Conceptual documentation](https://dev.bostondynamics.com/docs/concepts/readme). These documents explain the key abstractions used by the Spot API.
- [Payload developer documentation](https://dev.bostondynamics.com/docs/payload/readme). Payloads add additional sensing, communication, and control capabilities beyond what the base platform provides. The Payload ICD covers the mechanical, electrical, and software interfaces that Spot supports.
- [Spot API protocol definition](https://dev.bostondynamics.com/docs/protos/readme). This reference guide covers the details of the protocol applications used to communicate to Spot. Application developers who wish to use a language other than Python can implement clients that speak the protocol.

This is version 4.1.0 of the C++ SDK. Please review the [Release Notes](docs/cpp_release_notes.md) to see what has changed.
This is version 4.1.0 of the C++ SDK. Please review the [Release Notes](https://github.com/bdaiinstitute/spot-cpp-sdk/blob/ros2/docs/cpp_release_notes.md) to see what has changed.

## Contents

- [C++ Library](docs/cpp/README.md)
- [Release Notes](docs/cpp_release_notes.md)
- [SDK Repository](https://github.com/boston-dynamics/spot-cpp-sdk)
- [C++ Library](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2/docs/cpp)
- [Release Notes](https://github.com/bdaiinstitute/spot-cpp-sdk/blob/ros2/docs/cpp_release_notes.md)
- [SDK Repository](https://github.com/bdaiinstitute/spot-cpp-sdk)
6 changes: 3 additions & 3 deletions cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ Library Dependencies:

## Contents

- [Client](bosdyn/client/README.md)
- [Common](bosdyn/common/README.md)
- [Math](bosdyn/math/README.md)
- [Client](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2/cpp/bosdyn/client)
- [Common](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2/cpp/bosdyn/common)
- [Math](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2/cpp/bosdyn/math)

0 comments on commit 20b3872

Please sign in to comment.