i/OrbbecSDK_ROS2
1
0
Fork 0
mirror of https://github.com/orbbec/OrbbecSDK_ROS2.git synced 2026-10-12 23:39:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refactor migration guide formatting for consistency

Browse Source
This commit is contained in:
obyalian
2025-10-22 11:16:36 +08:00
parent 2c1d661d9c
commit c4a742a315
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/source/7_developer_guide/migration_guide.md
+2 -2
View File
@@ -1,6 +1,6 @@
# Migrating from main to Open-Source v2-main # Migrating from main to Open-Source v2-main
## **Introduction** ## Introduction
Initially, Orbbec provided a **closed-source SDK — Orbbec SDK v1**, which formed the foundation of the [OrbbecSDK ROS2 Wrapper main branch](https://github.com/orbbec/OrbbecSDK_ROS2/tree/main). Although the ROS wrapper layer itself was open-source, it relied on a closed-source underlying SDK. This architecture imposed limitations on flexibility and hindered community-driven improvements. Initially, Orbbec provided a **closed-source SDK — Orbbec SDK v1**, which formed the foundation of the [OrbbecSDK ROS2 Wrapper main branch](https://github.com/orbbec/OrbbecSDK_ROS2/tree/main). Although the ROS wrapper layer itself was open-source, it relied on a closed-source underlying SDK. This architecture imposed limitations on flexibility and hindered community-driven improvements.
@@ -10,7 +10,7 @@ This document introduces the motivations and benefits of migrating ROS packages
**Note:** In the following content, **main** refers to the closed-source branch, while **v2-main** refers to the open-source v2-main branch. **Note:** In the following content, **main** refers to the closed-source branch, while **v2-main** refers to the open-source v2-main branch.
## **Advantages of Migrating from main to v2-main** ## Advantages of Migrating from main to v2-main
In October 2024, Orbbec released a major update: **OrbbecSDK ROS2 Wrapper v2**, which is entirely based on the open-source Orbbec SDK_v2. Compared to the legacy main branch (SDK v1.x), the v2-main branch (Orbbec SDK_v2.x) provides greater flexibility and scalability, while offering comprehensive support for all Orbbec USB products that comply with the UVC standard.The migration from main --> v2-main brings the following key advantages: In October 2024, Orbbec released a major update: **OrbbecSDK ROS2 Wrapper v2**, which is entirely based on the open-source Orbbec SDK_v2. Compared to the legacy main branch (SDK v1.x), the v2-main branch (Orbbec SDK_v2.x) provides greater flexibility and scalability, while offering comprehensive support for all Orbbec USB products that comply with the UVC standard.The migration from main --> v2-main brings the following key advantages:
docs/zh/source/7_developer_guide/migration_guide.md
+2 -2
View File
@@ -1,6 +1,6 @@
# 从 main 分支迁移到开源 v2-main 分支 # 从 main 分支迁移到开源 v2-main 分支
## **引言** ## 引言
最初，奥比中光提供了一个**闭源 SDK — Orbbec SDK v1**，它构成了 [OrbbecSDK ROS2 Wrapper main 分支](https://github.com/orbbec/OrbbecSDK_ROS2/tree/main)的基础。虽然 ROS 封装层本身是开源的，但它依赖于闭源的底层 SDK。这种架构限制了灵活性，阻碍了社区驱动的改进。 最初，奥比中光提供了一个**闭源 SDK — Orbbec SDK v1**，它构成了 [OrbbecSDK ROS2 Wrapper main 分支](https://github.com/orbbec/OrbbecSDK_ROS2/tree/main)的基础。虽然 ROS 封装层本身是开源的，但它依赖于闭源的底层 SDK。这种架构限制了灵活性，阻碍了社区驱动的改进。
@@ -10,7 +10,7 @@
**注意：** 在以下内容中，**main** 指闭源分支，而 **v2-main** 指开源 v2-main 分支。 **注意：** 在以下内容中，**main** 指闭源分支，而 **v2-main** 指开源 v2-main 分支。
## **从 main 迁移到 v2-main 的优势** ## 从 main 迁移到 v2-main 的优势
2024年10月，奥比中光发布了重大更新：**OrbbecSDK ROS2 Wrapper v2**，它完全基于开源的 Orbbec SDK_v2。与传统的 main 分支（SDK v1.x）相比，v2-main 分支（Orbbec SDK_v2.x）提供了更大的灵活性和可扩展性，同时为所有符合 UVC 标准的奥比中光 USB 产品提供全面支持。从 main --> v2-main 的迁移带来以下关键优势： 2024年10月，奥比中光发布了重大更新：**OrbbecSDK ROS2 Wrapper v2**，它完全基于开源的 Orbbec SDK_v2。与传统的 main 分支（SDK v1.x）相比，v2-main 分支（Orbbec SDK_v2.x）提供了更大的灵活性和可扩展性，同时为所有符合 UVC 标准的奥比中光 USB 产品提供全面支持。从 main --> v2-main 的迁移带来以下关键优势：