diff --git a/README.md b/README.md index 718b879c..36907709 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,7 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) ## Documents * Github Pages:[https://orbbec.github.io/OrbbecSDK/](https://orbbec.github.io/OrbbecSDK/) +* Overview Document:[doc/tutorial/English/OverviewDocument.md](doc/tutorial/English/OverviewDocument.md) * API Reference: [doc/api/English/index.html](https://orbbec.github.io/OrbbecSDK/doc/api/English/index.html) * OrbbecSDK C++ API user guide:[doc/tutorial/English/OrbbecSDK_C++_API_user_guide-v1.0.pdf](https://orbbec.github.io/OrbbecSDK/doc/tutorial/English/OrbbecSDK_C++_API_user_guide-v1.0.pdf) * Environment Configuration:[doc/tutorial/English/Environment_Configuration.md](doc/tutorial/English/Environment_Configuration.md) diff --git a/README_CN.md b/README_CN.md index d38b1afb..d990071b 100644 --- a/README_CN.md +++ b/README_CN.md @@ -134,6 +134,7 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) ## 文档 * Github:[https://orbbec.github.io/OrbbecSDK/](https://orbbec.github.io/OrbbecSDK/README_CN) +* 概述文档:[doc/tutorial/Chinese/OverviewDocument.md](doc/tutorial/Chinese/OverviewDocument.md) * API 参考: [doc/api/Chinese/index.html](https://orbbec.github.io/OrbbecSDK/doc/api/Chinese/index.html) * OrbbecSDK C++ API user guide:[doc/tutorial/Chinese/OrbbecSDK_C++_API_user_guide-v1.0.pdf](https://orbbec.github.io/OrbbecSDK/doc/tutorial/Chinese/OrbbecSDK_C++_API_user_guide-v1.0.pdf) * Environment Configuration:[doc/tutorial/Chinese/Environment_Configuration.md](doc/tutorial/Chinese/Environment_Configuration.md) @@ -141,6 +142,7 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) * 示例描述: [doc/tutorial/Chinese/Code_Sample_Description/Sample_Description(C_C++).md](doc/tutorial/Chinese/Code_Sample_Description/Sample_Description(C_C++).md) + ## 相关链接 * [奥比中光主页](https://www.orbbec.com.cn/) diff --git a/doc/tutorial/English/OverviewDocument.md b/doc/tutorial/English/OverviewDocument.md index dcee3632..117d1ce9 100644 --- a/doc/tutorial/English/OverviewDocument.md +++ b/doc/tutorial/English/OverviewDocument.md @@ -4,7 +4,7 @@ Welcome to the Orbbec SDK (hereinafter referred to as "SDK") tutorial! The SDK n # Features Orbbec SDK is a cross-platform (Windows, Android, Linux) software development kit that provides device parameter configuration, data stream reading and stream processing for 3D sensing cameras such as Orbbec structured light, binocular, and iToF. -**Core functions: ** +**Core functions:** - Depth camera access and related parameter settings - RGB camera access and related parameter settings (eg exposure and white balance)