run-cmake 项目使用教程

1. 项目目录结构及介绍

run-cmake 项目是一个用于在 GitHub Actions 中构建 C++ 应用程序的自动化工具，它使用 CMake、Ninja 和 vcpkg。以下是项目的目录结构及各部分的作用介绍：

run-cmake/
├── .github/              # 存放 GitHub Actions 工作流的配置文件
│   ├── workflows/
│   └── ...
├── __tests__/            # 存放测试相关的文件和目录
├── dist/                 # 存放构建后生成的文件
├── docs/                 # 存放项目文档
│   └── imgs/             # 存放文档中的图片
├── src/                  # 存放项目的源代码
├── .eslintignore         # ESLint 忽略文件
├── .eslintrc.js          # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置文件
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE.txt           # 项目许可证文件
├── README.md             # 项目自述文件
├── action.yml            # GitHub Action 配置文件
├── jest.config.js        # Jest 测试配置文件
├── package-lock.json     # npm 包版本锁定文件
├── package.json          # npm 包配置文件
├── tsconfig-base.json    # TypeScript 基础配置文件
└── tsconfig.json         # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要是通过 GitHub Actions 工作流来触发的。在 .github/workflows 目录下，你可以找到相关的 YAML 配置文件，这些文件定义了自动化构建的过程。

以下是一个简单的启动文件示例：

name: build

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup CMake
        uses: lukka/get-cmake@latest
      - name: Setup vcpkg
        uses: lukka/run-vcpkg@v11
        with:
          vcpkgDirectory: '${{ github.workspace }}/vcpkg'
      - name: Run CMake and build
        uses: lukka/run-cmake@v10
        with:
          cmakeListsTxtPath: '${{ github.workspace }}/CMakeLists.txt'
          configurePreset: 'ninja-multi-vcpkg'
          buildPreset: 'ninja-multi-vcpkg'

这个工作流会在每次代码推送时自动执行，首先检出代码，然后设置 CMake 和 vcpkg，最后运行 CMake 来构建项目。

3. 项目的配置文件介绍

项目的配置主要通过 CMakePresets.json 文件进行。CMakePresets.json 文件定义了不同的构建预设，包括构建类型、编译器和所需依赖等。

以下是一个 CMakePresets.json 文件的示例：

{
  "version": 2,
  "configurePresets": [
    {
      "name": "ninja-multi-vcpkg",
      "binaryDir": "${sourceDir}/build",
      "cacheDir": "${sourceDir}/build/cache",
      "generator": "Ninja",
      "toolchainFile": "${sourceDir}/vcpkg.cmake"
    }
  ],
  "buildPresets": [
    {
      "name": "ninja-multi-vcpkg",
      "configurePreset": "ninja-multi-vcpkg",
      "buildCommand": "ninja"
    }
  ],
  "testPresets": [
    {
      "name": "ninja-multi-vcpkg",
      "configurePreset": "ninja-multi-vcpkg",
      "buildPreset": "ninja-multi-vcpkg",
      "testCommand": "ninja test"
    }
  ]
}

在这个配置文件中，定义了一个名为 ninja-multi-vcpkg 的预设，它指定了使用 Ninja 作为构建系统，并使用 vcpkg 作为依赖管理工具。通过修改这个文件，可以添加或修改构建预设，以满足不同的构建需求。