Skip to content

Commit 422634c

Browse files
committed
Update READMEs
Signed-off-by: Michel Hidalgo <[email protected]>
1 parent b4dcb83 commit 422634c

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,27 @@ is subject to the terms and conditions of the Boston Dynamics Software
66
Development Kit License (20191101-BDSDK-SL).
77
-->
88

9-
# Spot C++ SDK (BETA)
9+
# Spot C++ SDK (BETA) in ROS 2
10+
11+
**This is fork of [`boston-dynamics/spot-cpp-sdk`](https://github.com/boston-dynamics/spot-cpp-sdk) patched for ROS 2 release. Proceed upstream for any inquiry or request.**
1012

1113
Develop applications and payloads for Spot using the Boston Dynamics Spot C++ SDK. The Spot C++ SDK is a **beta** release.
1214

1315
The C++ SDK consists of:
1416

15-
- [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.
16-
- [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.
17+
- [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.
18+
- [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.
1719

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

2022
- [Conceptual documentation](https://dev.bostondynamics.com/docs/concepts/readme). These documents explain the key abstractions used by the Spot API.
2123
- [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.
2224
- [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.
2325

24-
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.
26+
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.
2527

2628
## Contents
2729

28-
- [C++ Library](docs/cpp/README.md)
29-
- [Release Notes](docs/cpp_release_notes.md)
30-
- [SDK Repository](https://github.com/boston-dynamics/spot-cpp-sdk)
30+
- [C++ Library](https://github.com/bdaiinstitute/spot-cpp-sdk/tree/ros2/docs/cpp)
31+
- [Release Notes](https://github.com/bdaiinstitute/spot-cpp-sdk/blob/ros2/docs/cpp_release_notes.md)
32+
- [SDK Repository](https://github.com/bdaiinstitute/spot-cpp-sdk)

cpp/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ Library Dependencies:
2828

2929
## Contents
3030

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

0 commit comments

Comments
 (0)