From dfa4e66a35b1204a9887f0b184d717672151030b Mon Sep 17 00:00:00 2001 From: zhonghong Date: Mon, 28 Oct 2024 16:31:48 +0800 Subject: [PATCH] update readme --- README.md | 9 +++++++-- README_CN.md | 4 +++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d3cb8d5d..5120b5eb 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,14 @@ ![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.10.12-green) + + +## Introduction The Orbbec 3D camera product software development kit fully supports UVC, enabling driver-free plug-and-play. It provides both low-level and high-level APIs that are simple and easy to use, allowing developers to use it flexibly in different scenarios. -Additionally, this SDK is compatible with Orbbec's original OpenNI protocol devices through built-in code, enabling developers to migrate to Orbbec SDK to support both new and old products with one set of code. +This main branch is based on branch v1.x and it is compatible with Orbbec's original OpenNI protocol devices through built-in code, enabling developers to migrate to Orbbec SDK to support both new and old products with one set of code. + +With the major update in a new branch v2.x in 2024 October, Orbbec SDK becomes open-source with enhanced flexibility and scalability. This update in v2.x ensures compatibility with all new Orbbec USB products that adhere to the UVC standard. However, [OrbbecSDK v2.x](https://github.com/orbbec/OrbbecSDK-dev) no longer supports Orbbec's legacy OpenNI protocol devices, which will continue to receive bug fixes support in the v1.x branch. We encourage you to check out whether your devices is supported by OrbbecSDK v2.x and use the new release if it is supported there. If you are a user in China, it is recommended to use Gitee([gitee Repo](https://gitee.com/orbbecdeveloper/OrbbecSDK)). @@ -176,7 +181,7 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) **Insufficient Power Supply**: - Ensure that all cameras are not connected to the same hub. - Use a powered hub to provide sufficient power to each camera. - + **High Resolution**: - Try lowering the resolution to resolve data stream issues. diff --git a/README_CN.md b/README_CN.md index 47f5ae38..f792961e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -4,7 +4,9 @@ Orbbec 3D 相机产品软件开发套件，全面支持 UVC，实现免驱动即插即用，提供低层和高层简单易用的 API，帮助开发者在不同场景下灵活使用。 -此外，该 SDK 通过内置代码兼容 Orbbec 原有的 OpenNI 协议设备，开发者可以完全迁移到 OrbbecSDK，一套代码即可支持 Orbbec 的新一代产品和老产品。 +这个主分支是基于 v1.x 分支构建的，它通过内置代码与 Orbbec 原始的 OpenNI 协议设备兼容，使开发者能够迁移到 Orbbec SDK，用一套代码支持新旧产品。 + +随着2024年10月新分支v2.x的重大更新，Orbbec SDK 变得开源，增强了灵活性和可扩展性。这次 v2.x 的更新确保了与所有遵循 UVC 标准的新 Orbbec USB 产品的兼容性。然而，[OrbbecSDK v2.x](https://github.com/orbbec/OrbbecSDK-dev) 不再支持 Orbbec 的旧版 OpenNI 协议设备，这些设备将继续在 v1.x 分支中获得错误修复支持。我们鼓励你检查你的设备是否支持 OrbbecSDK v2.x，并在支持的情况下使用新版本。 如果你是中国的用户，建议使用 Gitee([gitee Repo](https://gitee.com/orbbecdeveloper/OrbbecSDK))。