[1.9.x_tmp0313][README.MD]: The description of license structure is a…

…dded to README.MD. Add new license and readme.md to the lib&driver directory.
orbbec · Mar 13, 2024 · cc724a6 · cc724a6
1 parent fb327a2
commit cc724a6
Show file tree

Hide file tree

Showing 8 changed files with 79 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,6 @@ The Orbbec 3D camera product software development kit fully supports UVC, enabli
 
 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.
 
-
 If you are a user in China, it is recommended to use Gitee([gitee Repo](https://gitee.com/orbbecdeveloper/OrbbecSDK)).
 
 ## What is included in the repository
@@ -17,15 +16,23 @@ If you are a user in China, it is recommended to use Gitee([gitee Repo](https://
 * **driver** : Windows device driver for OpenNI protocol devices (Dabai, Dabai DCW, Dabai DW, Astra mini Pro, Astra Pro Plus, A1 Pro, Gemini E, Gemini E Lite, Gemini). While modules that use the standard UVC protocol do not need to install drivers.
 * **scripts** : Linux udev rules for resolving permission issues and Windows timestamp registration scripts for resolving timestamp and metadata issues.
 
+## license structure
+
+The current software license structure is as follows
+![SdkLicenseDiagram](doc/resources/sdk_licensediagram.png)
+
+In the near future following software lincense structure will be optimized as follows
+![SdkLicenseDiagramFuture](doc/resources/sdk_licenseiagram_future.png)
+
 ## Platform support
 
-| Operating system | Requirement                                                                                        | Description                                                                                                                             |
-|------------------|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| Windows          | - Windows 10 April 2018 (version 1803, operating system build 17134) release (x64) or higher<br /> | The generation of the VS project depends on the installation of the VS version and the cmake version, and supports VS2015/vs2017/vs2019 |
-| Linux            | - Linux Ubuntu 16.04/18.04/20.04 (x64)<br />                                                       | Support GCC 7.5                                                                                                                         |
-| Arm32            | - Linux Ubuntu 16.04/18.04/20.04<br />                                                             | Support GCC 7.5                                                                                                                         |
-| Arm64            | - Linux Ubuntu 18.04/20.04<br />                                                                   | Support GCC 7.5                                                                                                                         |
-| MacOS            | - M series chip, 11.0 and above、intel x86 chip, 10.15 and above. <br />                            | supported hardware products: Gemini 2, Gemini 2 L, Astra 2,Gemini 2 XL, Femto Mega                                                      |
+| Operating system | Requirement                                                                                  | Description                                                                                                                             |
+|------------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| Windows          | - Windows 10 April 2018 (version 1803, operating system build 17134) release (x64) or higher | The generation of the VS project depends on the installation of the VS version and the cmake version, and supports VS2015/vs2017/vs2019 |
+| Linux            | - Linux Ubuntu 16.04/18.04/20.04 (x64)                                                       | Support GCC 7.5                                                                                                                         |
+| Arm32            | - Linux Ubuntu 16.04/18.04/20.04                                                             | Support GCC 7.5                                                                                                                         |
+| Arm64            | - Linux Ubuntu 18.04/20.04                                                                   | Support GCC 7.5                                                                                                                         |
+| MacOS            | - M series chip, 11.0 and above、intel x86 chip, 10.15 and above.                             | supported hardware products: Gemini 2, Gemini 2 L, Astra 2,Gemini 2 XL, Femto Mega                                                      |
 
 * Note: supported Arm platforms: jestson nano (arm64)、 AGX Orin(arm64)、Orin NX (arm64)、Orin Nano(arm64)、A311D (arm64), Raspberry Pi 4 (arm64), Raspberry Pi 3 (arm32), rk3399 (arm64), other Arm systems, may need to Cross-compile.
 * Windows 11, Ubuntu 22.04 and other Linux platforms may also be supported, but have not been fully tested.
@@ -52,8 +59,6 @@ If you are a user in China, it is recommended to use Gitee([gitee Repo](https://
 | Gemini            | 3.0.18                      |
 | Astra Mini S Pro  | 1.0.05                      |
 
-
-
 ## OrbbecViewer
 
 OrbbecViewer is a useful tool based on Orbbec SDK，that can be used to view the data stream from the Orbbec camera and control the camera.
@@ -65,7 +70,6 @@ OrbbecViewer is a useful tool based on Orbbec SDK，that can be used to view the
 
 **OrbbecViewer User Manual**: [OrbbecViewer User Manual](doc/OrbbecViewer/English/OrbbecViewer.md)
 
-
 ## Getting started
 
 ### Get source code
@@ -76,26 +80,21 @@ git clone https://github.com/orbbec/OrbbecSDK.git
 
 ### Environment setup
 
-
 * Linux:
 
-    Install udev rules file
-
-    ``` bash
-    cd OrbbecSDK/misc/scripts
-    sudo chmod +x ./install_udev_rules.sh
-    sudo ./install_udev_rules.sh
-    sudo udevadm control --reload && sudo udevadm trigger
-    ```
+  Install udev rules file
 
+  ```bash
+  cd OrbbecSDK/misc/scripts
+  sudo chmod +x ./install_udev_rules.sh
+  sudo ./install_udev_rules.sh
+  sudo udevadm control --reload && sudo udevadm trigger
+  ```
 * Windows:
 
-    Timestamp registration: [follow this: obsensor_metadata_win10](misc/scripts/obsensor_metadata_win10.md)
-
+  Timestamp registration: [follow this: obsensor_metadata_win10](misc/scripts/obsensor_metadata_win10.md)
 * *For more information, please refer to：[Environment Configuration](doc/tutorial/English/Environment_Configuration.md)*
 
-
-
 ## Examples
 
 The sample code is located in the `./examples` directory and can be built using CMake.
@@ -110,12 +109,14 @@ cd OrbbecSDK && mkdir build && cd build && cmake .. && cmake --build . --config
 
 To connect your Orbbec camera to your PC, run the following steps:
 
-``` bash
+```bash
 cd OrbbecSDK/build/bin # build output dir
 ./OBMultiStream  # OBMultiStream.exe on Windows
 ```
+
 Notes: On MacOS, sudo privileges are required.
-``` bash
+
+```bash
 # MacOS
 cd OrbbecSDK/build/bin # build output dir
 sudo ./OBMultiStream
@@ -128,7 +129,6 @@ The following image is the result of running MultiStream on the Gemini2 device.
 Notes:
 On the Linux/Arm platform ,this sample requires users to compile with Opencv4.2 or above,otherwise, it cannot be rendered.
 
-
 ### Use Orbbec SDK in your CMake project
 
 Find and link Orbbec SDK in your CMakeLists.txt file like this:
@@ -147,8 +147,6 @@ find_package(OrbbecSDK REQUIRED)
 target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK)
 ```
 
-
-
 ## Documents
 
 * Github Pages：[https://orbbec.github.io/OrbbecSDK/](https://orbbec.github.io/OrbbecSDK/)

diff --git a/README_CN.md b/README_CN.md
@@ -16,18 +16,25 @@ Orbbec 3D 相机产品软件开发套件，全面支持 UVC，实现免驱动即
 * **driver** :  Windows 设备驱动，用于 OpenNI 协议设备（Dabai、Dabai DCW、Dabai DW、Astra mini Pro、Astra Pro Plus、A1 Pro、Gemini E、Gemini E Lite、Gemini），使用标准 UVC 协议的模块则无需安装驱动。
 * **scripts** : Linux udev 规则，用于解决权限问题；Windows 时间戳注册脚本，用于解决时间戳和元数据问题。
 
+## 软件license结构说明
+
+当前遵循软件license结构如下
+![SdkLicenseDiagram](doc/resources/sdk_licensediagram.png)
+
+在不久将来遵循软件lincense结构会优化如下
+![SdkLicenseDiagramFuture](doc/resources/sdk_licenseiagram_future.png)
+
 ## 支持平台
 
-| Operating system | Requirement                                                                                        | Description                                                                                                                             |
-|------------------|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| Windows          | - Windows 10 April 2018 (version 1803, operating system build 17134) release (x64) or higher<br /> | The generation of the VS project depends on the installation of the VS version and the cmake version, and supports VS2015/vs2017/vs2019 |
-| Linux            | - Linux Ubuntu 16.04/18.04/20.04 (x64)<br />                                                       | Support GCC 7.5                                                                                                                         |
-| Arm32            | - Linux Ubuntu 16.04/18.04/20.04<br />                                                             | Support GCC 7.5                                                                                                                         |
-| Arm64            | - Linux Ubuntu 18.04/20.04<br />                                                                   | Support GCC 7.5                                                                                                                         |
-| MacOS            | - M series chip, 11.0 and above、intel x86 chip, 10.15 and above. <br />                            | supported hardware products: Gemini 2, Gemini 2 L, Astra 2,Gemini 2 XL, Femto Mega                                                      |
+| Operating system | Requirement                                                                                  | Description                                                                                                                             |
+|------------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| Windows          | - Windows 10 April 2018 (version 1803, operating system build 17134) release (x64) or higher | The generation of the VS project depends on the installation of the VS version and the cmake version, and supports VS2015/vs2017/vs2019 |
+| Linux            | - Linux Ubuntu 16.04/18.04/20.04 (x64)                                                       | Support GCC 7.5                                                                                                                         |
+| Arm32            | - Linux Ubuntu 16.04/18.04/20.04                                                             | Support GCC 7.5                                                                                                                         |
+| Arm64            | - Linux Ubuntu 18.04/20.04                                                                   | Support GCC 7.5                                                                                                                         |
+| MacOS            | - M series chip, 11.0 and above、intel x86 chip, 10.15 and above.                             | supported hardware products: Gemini 2, Gemini 2 L, Astra 2,Gemini 2 XL, Femto Mega                                                      |
 
 * 注: 当前版本支持的Arm平台：jestson nano(arm64)、AGX Orin(arm64)、Orin NX (arm64)、Orin Nano(arm64)、A311D(arm64)、树莓派4(arm64)、树莓派3（arm32)、rk3399(arm64), 其它Arm系统，可能需要重新交叉编译。
-
 * Windows 11, Ubuntu 22.04 和其他一些 Linux 平台理论上也支持，但是未经过完整测试”
 
 ## 支持产品
@@ -52,8 +59,8 @@ Orbbec 3D 相机产品软件开发套件，全面支持 UVC，实现免驱动即
 | Gemini           | 3.0.18                      |
 | Astra Mini S Pro | 1.0.05                      |
 
-
 ## OrbbecViewer
+
 OrbbecViewer是一个基于Orbbec SDK的实用工具，用于查看来自Orbbec相机的数据流并控制相机.
 
 ![OrbbecViewer](doc/resources/OrbbecViewer.png)
@@ -64,49 +71,39 @@ OrbbecViewer是一个基于Orbbec SDK的实用工具，用于查看来自Orbbec
 
 **OrbbecViewer使用说明**: [OrbbecViewer User Manual](doc/OrbbecViewer/Chinese/OrbbecViewer.md)
 
-
 ## 快速开始
 
 ### 获取源码
 
-    ```bash
-    git clone https://github.com/Orbbec/OrbbecSDK.git
-    ```
+    ``bash     git clone https://github.com/Orbbec/OrbbecSDK.git     ``
 
 ### 环境配置
-* Linux：
 
-    安装 udev rules 文件
+* Linux：
 
-    ``` bash
-    cd OrbbecSDK/misc/scripts
-    sudo chmod +x ./install_udev_rules.sh
-    sudo ./install_udev_rules.sh
-    sudo udevadm control --reload && sudo udevadm trigger
-    ```
+  安装 udev rules 文件
 
+  ```bash
+  cd OrbbecSDK/misc/scripts
+  sudo chmod +x ./install_udev_rules.sh
+  sudo ./install_udev_rules.sh
+  sudo udevadm control --reload && sudo udevadm trigger
+  ```
 * Windows：
-    metadat时间戳注册: [obsensor_metadata_win10](misc\scripts\obsensor_metadata_win10.md)
-
+  metadat时间戳注册: [obsensor_metadata_win10](misc\scripts\obsensor_metadata_win10.md)
 * 有关环境配置的更多信息请参考：[Environment Configuration](doc/tutorial/Chinese/Environment_Configuration.md)
 
-
-
 ## 示例
+
 示例代码位于./examples目录中，可以使用CMake进行编译
 
 ### 编译
 
-    ```bash
-    cd OrbbecSDK && mkdir build && cd build && cmake .. && cmake --build . --config Release
-    ```
+    ``bash     cd OrbbecSDK && mkdir build && cd build && cmake .. && cmake --build . --config Release     ``
 
 ### 运行示例
-    首先连接Orbbec相机，然后运行如下脚本：
-    ```bash
-    cd OrbbecSDK/build/bin # build output dir
-    ./OBMultiStream  # OBMultiStream.exe on Windows
-    ```
+
+    首先连接Orbbec相机，然后运行如下脚本：``bash     cd OrbbecSDK/build/bin # build output dir     ./OBMultiStream  # OBMultiStream.exe on Windows     ``
 
 下图是Gemini2 设备，运行MultiStream的结果图，其它设备运行的结果可能不一样.
 ![Multistream](doc/resources/Multistream.png)
@@ -132,7 +129,6 @@ find_package(OrbbecSDK REQUIRED)
 target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK)
 ```
 
-
 ## 文档
 
 * Github：[https://orbbec.github.io/OrbbecSDK/](https://orbbec.github.io/OrbbecSDK/README_CN)
@@ -143,8 +139,6 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK)
 * 示例说明: [examples/README.md](examples/README_CN.md)
 * 示例描述: [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/resources/sdk_licensediagram.png b/doc/resources/sdk_licensediagram.png
diff --git a/doc/resources/sdk_licenseiagram_future.png b/doc/resources/sdk_licenseiagram_future.png
diff --git a/lib/README.md b/lib/README.md
@@ -0,0 +1,3 @@
+# Orbbec SDK lib
+
+OrbbecSDK Because the library files, depth engine and driver files, are dedicated code, do not belong to the mit protocol.  lib license reference lib/license
diff --git a/lib/license b/lib/license
@@ -0,0 +1,8 @@
+Copyright (c) 2023 OrbbecDeveloper
+
+Scope of License: This license grants, free of charge, to any person obtaining a copy of this repository or substantial portions of this repository, the right to use the files in this repository for ultilizing products from Orbbec Inc.
+You may apply this repository for personal, academic, and commercial use. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the repository.
+Prohibited Actions: You are prohibited from modifying, decompiling, or reverse engineering any part of this library. You cannot use this library for products other than those of Orbbec.
+Reservation of Rights: The author reserves the right to modify this license at any time without prior notice. The author reserves all rights to this library.
+Disclaimer: This library is provided "as is," and the author assumes no responsibility for any direct, indirect, incidental, special, or consequential damages resulting from the use of this library.
+License Updates: If the author releases a new version of the license, you agree to comply with the new version after receiving notice.
diff --git a/misc/driver/README.md b/misc/driver/README.md
@@ -0,0 +1,3 @@
+# Orbbec SDK driver
+
+OrbbecSDK Because the library files, depth engine and driver files, are dedicated code, do not belong to the mit protocol.  driver license reference misc/driver/license
diff --git a/misc/driver/license b/misc/driver/license
@@ -0,0 +1,8 @@
+Copyright (c) 2023 OrbbecDeveloper
+
+Scope of License: This license grants, free of charge, to any person obtaining a copy of this repository or substantial portions of this repository, the right to use the files in this repository for ultilizing products from Orbbec Inc.
+You may apply this repository for personal, academic, and commercial use. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the repository.
+Prohibited Actions: You are prohibited from modifying, decompiling, or reverse engineering any part of this library. You cannot use this library for products other than those of Orbbec.
+Reservation of Rights: The author reserves the right to modify this license at any time without prior notice. The author reserves all rights to this library.
+Disclaimer: This library is provided "as is," and the author assumes no responsibility for any direct, indirect, incidental, special, or consequential damages resulting from the use of this library.
+License Updates: If the author releases a new version of the license, you agree to comply with the new version after receiving notice.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Orbbec SDK lib

		OrbbecSDK Because the library files, depth engine and driver files, are dedicated code, do not belong to the mit protocol. lib license reference lib/license
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Orbbec SDK driver

		OrbbecSDK Because the library files, depth engine and driver files, are dedicated code, do not belong to the mit protocol. driver license reference misc/driver/license