From 422634cd3b908e48f7c462c7ca6fc5b8f47fee2e Mon Sep 17 00:00:00 2001 From: Michel Hidalgo Date: Mon, 2 Dec 2024 20:21:29 -0300 Subject: [PATCH] Update READMEs Signed-off-by: Michel Hidalgo --- README.md | 16 +++++++++------- cpp/README.md | 6 +++--- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b620c52..7e9d123 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,16 @@ is subject to the terms and conditions of the Boston Dynamics Software Development Kit License (20191101-BDSDK-SL). --> -# Spot C++ SDK (BETA) +# Spot C++ SDK (BETA) in ROS 2 + +**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.** Develop applications and payloads for Spot using the Boston Dynamics Spot C++ SDK. The Spot C++ SDK is a **beta** release. 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: @@ -21,10 +23,10 @@ The official Spot SDK documentation also contains information relevant to the C+ - [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) diff --git a/cpp/README.md b/cpp/README.md index 5a82ae5..0821121 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -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)