PackCC 使用教程

1. 项目目录结构及介绍

PackCC 是一个用于生成 C 语言解析器的工具。以下是 PackCC 项目的目录结构及其简要介绍：

packcc/
├── .gitignore          # 忽略文件列表
├── CMakeLists.txt      # CMake 配置文件
├── LICENSE             # 项目许可证
├── README.md           # 项目说明文件
├── benchmark/          # 性能测试相关文件
├── examples/           # 示例文件
├── import/             # 导入文件
├── misc/               # 杂项文件
├── src/                # 源代码文件
├── tests/              # 测试文件
└── workflows/          # GitHub Actions 工作流文件

• .gitignore: 指定 Git 忽略的文件和目录。
• CMakeLists.txt: 用于配置 CMake 构建系统的文件。
• LICENSE: 项目使用的 MIT 许可证文本。
• README.md: 包含项目简介、安装和使用说明的 Markdown 文件。
• benchmark/: 包含性能测试脚本和基准测试文件。
• examples/: 包含使用 PackCC 的示例代码。
• import/: 包含导入的 PEG 文件。
• misc/: 包含一些杂项文件，如文档和辅助脚本。
• src/: 包含 PackCC 的源代码。
• tests/: 包含测试 PackCC 功能的测试用例。
• workflows/: 包含 GitHub Actions 工作流文件，用于自动化构建和测试。

2. 项目的启动文件介绍

项目的启动主要是通过编译 src/ 目录下的 packcc.c 文件来生成 packcc 可执行文件。以下是编译和运行 PackCC 的基本步骤：

# 使用 C 编译器编译源代码
cc -o packcc src/packcc.c

# 运行 packcc 可执行文件
./packcc example.peg

其中 example.peg 是你编写的 PEG（Parsing Expression Grammar）文件，用于定义你的语法规则。

3. 项目的配置文件介绍

PackCC 的配置主要是通过 CMakeLists.txt 文件进行的。以下是 CMakeLists.txt 的基本用法：

# 创建构建目录
mkdir build
cd build

# 运行 CMake 配置
cmake ..

# 构建项目
cmake --build .

# 安装项目（需要管理员权限）
sudo cmake --install . --config Release

在 CMakeLists.txt 文件中，你可以配置项目的名称、版本、依赖项以及安装路径等。此外，还可以通过添加不同的 CMake 参数来启用或禁用某些功能，如 UTF-8 支持。