bring back tutorial

doc/tutorial/Chinese/Environment_Configuration.md

@@ -4,11 +4,16 @@
 
 # 安装说明
 
-Orbbec SDK 兼容标准 UVC 协议，支持的硬件设备符合标准 UVC 规格，Gemini2、Femto 、Femto W、Femto Mega、Astra2、Gemini2 L 、Gemini 330系列 这些模组使用的标准的 UVC 协议，因此不需要安装额外的驱动程序。
+Orbbec SDK 兼容标准 UVC 协议，支持的硬件设备符合标准 UVC 规格，Gemini2、Femto 、Femto W、Femto Mega、Astra+、Astra2、Gemini2 L 、Gemini 330系列 这些模组使用的标准的 UVC 协议，因此不需要安装额外的驱动程序。
 
 # windows 环境配置
 
-## 1. 配置 OpenCV（Examples 依赖）
+## 1. 安装私有驱动
+
+openni 私有驱动的目录如下：双击以下. exe 图片目录，安装驱动程序。Dabai、Dabai DCW、Dabai DW、Astra mini Pro、Astra Pro Plus、A1 Pro、Gemini E、Gemini E Lite、Gemini 这些是使用的 openni 的私有协议，需要安装私有的驱动。
+![image0](Image/orbbec_driver_000.png)
+
+## 2. 配置 OpenCV（Examples 依赖）
 
 数据渲染依赖第三方库 OpenCV，这里以 OpenCV 4.3.0 为例演示安装配置。
 
@@ -22,16 +27,16 @@ Orbbec SDK 兼容标准 UVC 协议，支持的硬件设备符合标准 UVC 规
 
 ![image3](Image/orbbec_opencv_003.png)
 
-## 2. metadata 时间戳注册
+## 3. metadata 时间戳注册
+
 现在因为Windows 系统机制，对于 UVC 协议设备，如果需要拿到时间戳等 metadata 信息，需要先往注册表完成注册。可依据 obsensor_metadata_win10.md 文档指引执行 obsensor_metadata_win10.ps1 脚本自动完成。
 ![image4](Image/orbbec_metadata.png)
 
+## 4. windows 编译说明
 
-## 3. windows 编译说明
 软件依赖：VisualStudio2019、cmake 3.10 及以上版本
 
 * 下载 / 获取我们的 SDK 软件包，以 1.5.7 版本为例介绍 windows 如何编译。
-
 * 打开 Cmake，将 “Examples” 文件夹设置为代码路径，“Examples”下的 “build” 文件夹设置为生成二进制文件的路径，如下图所示。如 Examples 下无 build，需要新建该文件夹。
 
 ![image5](Image/orbbec_sample_005.png)
@@ -45,7 +50,7 @@ Orbbec SDK 兼容标准 UVC 协议，支持的硬件设备符合标准 UVC 规
 ![image7](Image/orbbec_sample_007.png)
 
 * 可以通过以下两种方式打开 Sample 工程
-方法一：通过 cmake，点击 “Open Project” 按钮，打开 Visual Studio 工程
+  方法一：通过 cmake，点击 “Open Project” 按钮，打开 Visual Studio 工程
 
 ![image8](Image/orbbec_sample_008.png)
 
@@ -54,38 +59,47 @@ Orbbec SDK 兼容标准 UVC 协议，支持的硬件设备符合标准 UVC 规
 ![image9](Image/orbbec_sample_009.png)
 
 * 打开 Examples 工程界面如下所示：
-![image10](Image/orbbec_sample_010.png)
-
+  ![image10](Image/orbbec_sample_010.png)
 * 选择你想要运行的工程，右键点击并将其“设置为启动项目”, 在运行选项处选择 release 和 64 位版本。
-
 * 将设备连接到主机。
-
 * 将 bin 目录下的 dll 文件和配置文件拷贝到编译生成的 bin 路径下
-![image13](Image/orbbec_sample_013.png)
-
-* 运行 HelloOrbbec 工程，结果如下所示，至此第一个 Example 就运行成功了。
+  ![image13](Image/orbbec_sample_013.png)
+* 运行 OBHelloOrbbec 工程，结果如下所示，至此第一个 Example 就运行成功了。
 
 ![image14](Image/orbbec_sample_014.png)
 
 # linux 环境配置
 
 首先下载 Linux 或 ARM 的 OrbbecSDK，然后按照以下步骤进行编译。
 
+## 1、系统环境配置
+
+* 安装 libudev 库：
+
+```bash
+sudo apt install libudev-dev
+```
+
+* 安装 libusb 库：
+
+```bash
+sudo apt install libusb-dev
+```
 
-## 1、USB 访问权限配置
+## 2、USB 访问权限配置
 
-Linux 系统默认对 USB 设备的直接访问需要 root 权限，可以通过 rules 配置文件解决。在 OrbbecSDK 发布的文件解压后，在 Script 目录下会有一个 “99-obsensor-libusb.rules” 配置文件和 “install_udev_rules” 安装脚本，通过 sudo 命令执行 “install_udev_rules.sh” 脚本，即可完成 rules 配置文件的安装。
+Linux 系统默认对 USB 设备的直接访问需要 root 权限，可以通过 rules 配置文件解决。在 OrbbecSDK 发布的文件解压后，在 Script 目录下会有一个 “99-obsensor-libusb.rules” 配置文件和 “install_udev_rules.sh” 安装脚本，通过 sudo 命令执行 “install_udev_rules.sh” 脚本，即可完成 rules 配置文件的安装。
 ![image15](Image/orbbec_sample_linux_001.png)
 方法如下： 首先修改 “install_udev_rules.sh” 安装脚本的执行权限。
 
-``` bash
+```bash
 sudo chmod +x ./install_udev_rules.sh
 sudo ./install_udev_rules.sh
 ```
 
 成功执行安装脚本后，再接入设备时生效（已接入的设备需要重新拔插）。
 
-## 2. USBFS 缓存大小配置（可选）
+## 3. USBFS 缓存大小配置（可选）
 
 默认情况下，USBFS 缓存大小为 16 MB。此值不足以用于高分辨率图像或多个流和多个设备使用。用户可以将缓存大小增加到 128 MB。
 
@@ -107,39 +121,79 @@ sudo sh -c 'echo 128> /sys/module/usbcore/parameters/usbfs_memory_mb'
 
 对于 GRUB2（最常见）：
 
-  1. 打开 `/etc/default/grub`， 将：`GRUB_CMDLINE_LINUX_DEFAULT="quiet splash"`（或引号内的其他内容，取决于您的系统）替换为：`GRUB_CMDLINE_LINUX_DEFAULT="quiet splash usbcore.usbfs_memory_mb=128"`
+1. 打开 `/etc/default/grub`， 将：`GRUB_CMDLINE_LINUX_DEFAULT="quiet splash"`（或引号内的其他内容，取决于您的系统）替换为：`GRUB_CMDLINE_LINUX_DEFAULT="quiet splash usbcore.usbfs_memory_mb=128"`
+2. 更新 grub
 
-  2. 更新 grub
-
-     ```bash
-      sudo update-grub
-     ```
-
-  3. 重启你的系统
+   ```bash
+    sudo update-grub
+   ```
+3. 重启你的系统
 
 其他引导加载程序：配置其他引导加载程序的附加内核参数，请参阅您的引导加载程序手册。
 
-## 3. 验证设备状态
+## 4. 验证设备状态
 
 * 环境准备：ubuntu18.04 x64 desktop
-
 * 以 Astra + 为例，使用 USB 3.0 Type-C 数据线，用于与 PC 机连接。
-
 * 使用 lsusb 命令，查看是否 PC 系统有正确识别到相机。
 
 ![image16](Image/orbbec_sample_linux_002.png)
 
 * 通过 PID&VID 来判断相机是否正常被识别
-VID：2bc5 PID：0536(彩色相机)
-VID：2bc5 PID：0636(深度相机)
+  VID：2bc5 PID：0536(彩色相机)
+  VID：2bc5 PID：0636(深度相机)
 
-## 4. Linux Sample 编译
+## 5. Linux Sample 编译
 
-在 Examples 目录下新建一个 build 目录，如下：
+在 OrbbecSDK 目录下新建一个 build 目录，如下：
 ![image17](Image/orbbec_sample_linux_003.png)
 
-``` bash
+```bash
+cd OrbbecSDK
+mkdir build
 cd build
 cmake ..
 make
 ```
+
+# Mac 环境配置
+
+### 安装 Xcode 和 Homebrew
+
+1. **安装 Xcode**:
+
+   - Xcode 是Apple提供的官方开发工具，其中包含C++编译器.
+   - 您可以从 Mac App Store 免费下载.
+   - 安装Xcode还将安装命令行工具，其中包括GCC编译器和其他开发工具.
+2. **安装 Homebrew**:
+
+   - Homebrew 是 macOS 的包管理器，可用于安装各种开发工具和库.
+   - 安装 Homebrew，请在终端中执行以下命令:
+     ```bash
+     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+     ```
+   - 使用 Homebrew，您可以轻松安装其他开发工具，例如 Git.
+
+这些步骤将设置在 macOS 上进行 C++ 开发所需的基本工具.
+
+### 安装依赖项
+
+```bash
+brew install cmake opencv
+```
+
+### 编译并运行示例
+
+```bash
+cd OrbbecSDK
+mkdir build
+cd build
+cmake .. && make -j8
+make install
+cd install/bin
+sudo ./OBHelloOrbbec
+```
+
+# 常见 FAQ
+
+[常见问题 FAQ](https://developer.orbbec.com.cn/technical_library.html?id=59)

doc/tutorial/Chinese/Installation_guidance.md

@@ -0,0 +1,100 @@
+# 安装指南
+本文档描述如何在Windows和Linux操作系统上通过安装包安装Orbbec SDK。
+
+## Windows 安装指南
+
+从 [https://github.com/orbbec/OrbbecSDK/releases](https://github.com/orbbec/OrbbecSDK/releases) 下载安装程序 `OrbbecSDK_v1.x.x_win64.exe`。
+
+安装过程如下：
+
+1. 双击.exe文件，弹出以下对话框：
+
+![image0](Image/windows_install_1.png)
+
+2. 点击“下一步”，弹出以下对话框：
+
+![image0](Image/windows_install_2.png)
+
+3. 点击“我同意”，弹出以下对话框：
+
+![image0](Image/windows_install_3.png)
+
+4. 再次点击“下一步”：
+
+![image0](Image/windows_install_4.png)
+
+5. 点击“安装”并等待安装完成。
+
+![image0](Image/windows_install_5.png)
+
+6. 安装完成后，Orbbec SDK安装目录中的文件如下：
+
+![image0](Image/windows_install_6.png)
+
+可以通过桌面快捷方式访问Orbbec Viewer。
+
+
+## Linux /Arm64 安装指南
+
+### 通过.deb包安装
+
+.deb包下载链接：[https://github.com/orbbec/OrbbecSDK/releases](https://github.com/orbbec/OrbbecSDK/releases)
+
+`OrbbecSDK_v1.x.x_amd64.deb`是Linux x64的安装包。
+
+`OrbbecSDK_v1.x.x_arm64.deb`是ARM 64的安装包。
+
+1. 在Linux x64 (ubuntu)平台上，使用以下命令安装：
+
+```bash
+sudo dpkg -i OrbbecSDK_v1.x.x_amd64.deb
+```
+
+![image0](Image/Linux_Install_1.png)
+
+2) 使用`dpkg -L orbbecsdk`检查Orbbec SDK的整个包路径，而Orbbec SDK的头文件和库文件将被安装在`/usr/local`路径中。
+
+![image0](Image/Linux_Install_2.png)
+
+3) 输入`OrbbecViewer`来运行Orbbec Viewer。
+
+![image0](Image/Linux_Install_3.png)
+
+### 通过Debian Apt仓库安装
+
+1) 在终端中，输入以下命令以获取并添加用于验证的公钥：
+
+```bash
+wget -O - http://s3.amazonaws.com/orbbec-debian-repos-aws/repos/orbbec_sdk/pub_key.pub | sudo apt-key add -
+```
+
+* 通过输入以下命令检查公钥是否成功添加：
+
+```bash
+apt-key list
+```
+
+![image0](Image/Linux_Install_4.png)
+
+如果出现域名无法解析的问题，尝试以下命令重启系统DNS解析服务并重试第一个命令：
+
+```bash
+sudo systemctl restart systemd-resolved
+```
+
+2) 在终端中，输入以下命令添加apt源更新地址：
+
+```bash
+echo "deb http://s3.amazonaws.com/orbbec-debian-repos-aws/repos/orbbec_sdk stable main" | sudo tee /etc/apt/sources.list.d/orbbec-orbbecsdk.list
+```
+
+3) 通过以下命令可以查询orbbecsdk：
+
+```bash
+sudo apt update
+sudo apt search orbbecsdk
+```
+
+![image0](Image/Linux_Install_5.png)
+
+4) 通过`dpkg -L orbbecsdk`检查Orbbec SDK的安装目录，通过输入`OrbbecViewer`命令，您可以运行Orbbec Viewer。