yinyang 项目安装与使用教程

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

yinyang 项目的目录结构如下：

yinyang/
├── bin/
├── docs/
├── examples/
├── media/
├── scripts/
├── tests/
├── yinyang/
├── .gitignore
├── LICENSE.md
├── MANIFEST.in
├── README.md
├── pyproject.toml
└── setup.cfg

目录介绍：

• bin/: 存放可执行文件的目录。
• docs/: 存放项目文档的目录。
• examples/: 存放示例代码的目录。
• media/: 存放媒体文件的目录。
• scripts/: 存放脚本的目录，例如用于下载 SMT-LIB 2 基准测试的脚本。
• tests/: 存放测试代码的目录。
• yinyang/: 项目的主要代码目录。
• .gitignore: Git 忽略文件配置。
• LICENSE.md: 项目许可证文件。
• MANIFEST.in: 用于打包项目的配置文件。
• README.md: 项目介绍和使用说明。
• pyproject.toml: 项目构建配置文件。
• setup.cfg: 项目安装配置文件。

2. 项目的启动文件介绍

yinyang 项目的启动文件是 yinyang/bin/yinyang。这个文件是项目的可执行文件，用于启动 fuzzing 测试。

启动文件的使用方法：

./yinyang/bin/yinyang "z3 model_validate=true cvc4 --check-models -m -i -q" benchmarks

参数说明：

• z3 model_validate=true cvc4 --check-models -m -i -q: 指定要测试的 SMT 求解器。
• benchmarks: 指定基准测试文件夹。

3. 项目的配置文件介绍

yinyang 项目的主要配置文件是 setup.cfg 和 pyproject.toml。

setup.cfg 配置文件介绍：

setup.cfg 文件用于配置项目的安装选项，例如包的元数据、依赖项等。

pyproject.toml 配置文件介绍：

pyproject.toml 文件用于配置项目的构建系统和其他工具的选项，例如项目依赖、构建工具等。

配置文件的使用方法：

在安装项目时，这些配置文件会被自动读取并应用。例如，使用 pip3 install . 安装项目时，setup.cfg 和 pyproject.toml 中的配置会被应用。

pip3 install .

通过以上步骤，您可以成功安装并使用 yinyang 项目进行 SMT 求解器的 fuzzing 测试。