MYNT-EYE D SDK开源项目启动与配置教程

1. 项目的目录结构及介绍

MYNT-EYE D SDK 是一个为MYNT® EYE Depth相机提供支持的库。以下是项目的目录结构及其简要介绍：

.
├── 3rdparty/             # 第三方库目录
├── cmake/                # CMake 配置文件目录
├── docs/                 # 文档目录
├── include/              # 头文件目录
│   └── mynteyed/         # MYNT-EYE SDK相关的头文件
├── samples/              # 示例代码目录
├── scripts/              # 脚本文件目录
├── src/                  # 源代码目录
│   └── mynteyed/         # MYNT-EYE SDK的源代码
├── wrappers/             # 封装目录
│   └── ros/              # ROS封装目录
├── .commitlintrc.js      # Commit 规则配置文件
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置文件
├── CMakeLists.txt        # CMake 主配置文件
├── CPPLINT.cfg           # CPPLINT 配置文件
├── CommonDefs.mk          # 公共定义文件
├── Jenkinsfile           # Jenkins 持续集成配置文件
├── LICENSE               # 许可证文件
├── Makefile              # Makefile 文件
├── README.md             # 项目说明文件
└── mynteyed-config.cmake.in # MYNT-EYE 配置文件模板

2. 项目的启动文件介绍

项目的启动主要是通过CMake来进行配置和编译的。以下是主要的启动文件：

• CMakeLists.txt：这是CMake的主配置文件，用于定义项目的编译过程，包括寻找依赖、指定编译选项、添加编译目标等。

• Makefile：如果选择使用Make工具编译，这个文件将会被CMake生成，用于指导Make如何编译项目。

• Jenkinsfile：这是一个Jenkins持续集成配置文件，如果需要进行持续集成，这个文件会定义构建、测试等流程。

启动项目的基本步骤如下：

# 克隆项目到本地
git clone https://github.com/slightech/MYNT-EYE-D-SDK.git

# 进入项目目录
cd MYNT-EYE-D-SDK

# 创建构建目录并切换到该目录
mkdir build && cd build

# 运行CMake来配置项目
cmake ..

# 使用Make工具编译项目
make

3. 项目的配置文件介绍

项目中的配置文件主要用于定制化项目的编译和运行行为。

• .gitignore：配置Git忽略的文件和目录，以避免将不必要的文件提交到版本控制中。

• .commitlintrc.js：配置commit message的规则，用于规范项目的提交信息。

• mynteyed-config.cmake.in：这是一个CMake配置文件模板，用于生成mynteyed-config.cmake文件，这个文件包含了库的路径和其它相关信息，以便其他项目能够找到和使用MYNT-EYE D SDK。

在进行项目配置时，可能需要修改CMakeLists.txt文件来适应不同的编译环境和依赖关系。此外，根据具体需求，还可能需要修改.gitignore和.commitlintrc.js来满足项目的代码提交规范。