Coriander 项目安装与使用指南

1. 项目目录结构及介绍

Coriander 项目的目录结构如下：

coriander/
├── bin/
├── cmake/
├── doc/
├── docker/
├── include/cocl/
├── jenkins/
├── src/
├── test/
├── third_party/
├── .gitignore
├── .gitmodules
├── .travis.yml
├── CMakeLists.txt
├── LICENSE
├── README.md
├── install/
├── install_distro.py
├── pytest.ini

目录介绍

• bin/: 存放编译后的可执行文件。
• cmake/: 包含 CMake 配置文件。
• doc/: 存放项目文档。
• docker/: 包含 Docker 相关文件。
• include/cocl/: 包含项目的头文件。
• jenkins/: 包含 Jenkins 持续集成配置文件。
• src/: 项目的源代码。
• test/: 包含测试代码。
• third_party/: 存放第三方库。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• .travis.yml: Travis CI 配置文件。
• CMakeLists.txt: CMake 主配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• install/: 包含安装脚本和相关文件。
• install_distro.py: 安装脚本。
• pytest.ini: pytest 配置文件。

2. 项目启动文件介绍

Coriander 项目的启动文件主要是编译后的可执行文件，通常位于 bin/ 目录下。启动文件的生成依赖于项目的编译过程。

编译过程

1. 编写 CUDA 源代码文件：例如 cuda_sample.cu。
2. 使用 cocl 编译：

   $ cocl_py cuda_sample.cu
   

   编译后会生成可执行文件 cuda_sample。

启动命令

$ ./cuda_sample

3. 项目的配置文件介绍

Coriander 项目的配置文件主要包括以下几个：

CMakeLists.txt

这是 CMake 的主配置文件，定义了项目的构建规则和依赖关系。

.gitignore

Git 忽略文件配置，指定哪些文件和目录不需要被 Git 跟踪。

.gitmodules

Git 子模块配置，用于管理第三方库的版本。

.travis.yml

Travis CI 配置文件，定义了持续集成的构建和测试流程。

pytest.ini

pytest 配置文件，用于配置测试框架的参数和行为。

install_distro.py

安装脚本，用于自动化项目的安装过程。

通过这些配置文件，Coriander 项目能够实现自动化构建、测试和部署，确保项目的稳定性和可维护性。