**Gersemi：CMake代码美化器使用指南**

---

一、项目目录结构及介绍

Gersemi是一个专为CMake代码设计的格式化工具，旨在使你的CMake脚本更加整洁、易读，堪称CMake代码中的“宝藏”。项目基于Python开发，遵循MPL-2.0许可证。以下是典型的项目结构概览：

├── README.md             - 主要的说明文档，介绍项目功能、安装及使用方法。
├── setup.py              - Python包的安装脚本。
├── pylintrc              - Pylint配置文件，确保代码质量。
├── tox.ini               - 用于运行测试和环境管理的Tox配置。
├── github/workflows      - GitHub Actions的工作流程配置文件夹。
├── tests                 - 包含单元测试和集成测试的代码。
├── gersemi               - 核心源码模块，实现CMake代码的解析和格式化逻辑。
├── example               - 示例配置文件或示例CMake项目，演示如何使用Gersemi。
└── pre-commit-hooks      - 预提交钩子相关文件，便于在Git中集成Gersemi作为代码风格检查工具。

二、项目启动文件介绍

Gersemi的核心执行不依赖于特定的“启动文件”，而是通过命令行接口（CLI）调用来使用的。主要的交互点是通过运行Python脚本或者将其安装后利用gersemi命令来调用。例如，当你安装了Gersemi之后，可以在终端直接输入以下命令来格式化你的CMake代码：

gersemi -i path/to/your/CMakeLists.txt

这里，“-i”参数表示就地修改（In-place formatting），而path/to/your/CMakeLists.txt则是你想格式化的CMake文件路径。

三、项目的配置文件介绍

Gersemi的配置可以通过一个名为.gersemirc或指定的YAML文件进行定制。此配置文件允许用户自定义如最大行长度、缩进方式、处理未知命令的行为等格式化规则。虽然没有特定的“启动文件”，配置内容通常按以下结构设置：

line_length: 80         # 设置单行的最大长度，默认值为80。
indent: 4                # 使用空格的数量作为缩进，默认为4个空格。
--definitions:          # 自定义命令的定义文件或目录路径，可以添加多个路径。
  - path/to/custom_cmds
list_expansion: favour-inlining   # 控制列表展开策略，可选favour-inlining或favour-expansion。

这些配置项可以直接在命令行中覆盖，提供灵活的使用方式。此外，为了处理项目中可能存在的自定义CMake命令，你可以通过--definitions标志指定包含这些命令定义的文件或目录，以帮助Gersemi更好地理解并格式化代码。

通过以上介绍，你应该对Gersemi有了基本了解，能够设置和使用它来提升你的CMake代码的格式化水平。记得结合官方GitHub页面提供的最新信息，以获取最准确的使用指导和更新动态。