Fiat项目使用与配置指南

1. 项目目录结构及介绍

Fiat项目是一个Coq ADT合成库，其目录结构如下：

.
├── etc/                       # 存放辅助脚本和配置文件
├── src/                       # 源代码目录
│   ├── fiat-core/             # Fiat核心库
│   ├── parsers/              # 解析器库
│   └── parsers-examples/     # 解析器示例
├── .git/                      # Git版本控制系统文件
├── .github/                   # GitHub工作流和模板
├── _CoqProject.in             # Coq项目配置文件模板
├── autogen.sh                 # 自动生成脚本
├── fiat.actic                 # Fiat活动文件
├── Makefile                   # Makefile构建脚本
├── README.md                  # 项目自述文件
├── TODO                       # 待办事项列表
├── tarball.sh                 # 打包脚本
└── todos.sh                   # 待办事项脚本

• etc/ 目录包含了项目所需的辅助脚本和配置文件。
• src/ 目录包含了项目的核心源代码，分为 fiat-core、parsers 和 parsers-examples 三个子目录。
• .git/ 目录包含了Git版本控制系统的相关文件。
• .github/ 目录包含了GitHub的工作流和模板。
• _CoqProject.in 是Coq项目配置文件的模板。
• autogen.sh 是自动生成项目文件的脚本。
• Makefile 是构建项目所需的Makefile文件。
• README.md 是项目的自述文件，介绍了项目的基本信息和使用方法。
• TODO 和 todos.sh 用来记录和管理项目的待办事项。

2. 项目的启动文件介绍

在Fiat项目中，启动文件主要是 Makefile。这个文件定义了构建项目所需的规则和目标。以下是 Makefile 的基本使用方法：

# 构建核心库
make fiat-core

# 构建SQL-like库（已不再支持）
make querystructures

# 构建解析器库
make parsers

要构建核心库，可以在项目根目录下运行 make fiat-core 命令。

3. 项目的配置文件介绍

Fiat项目的配置文件主要是 _CoqProject.in。这个文件是Coq项目的配置文件模板，用于指定项目依赖的Coq库和插件。以下是一个配置文件的示例：

# Coq项目配置文件
{- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -}
# 项目名称和描述
Project "Fiat"
  Description "Coq ADT synthesis library"
  Version "1.0"

# 依赖的库
Require Coq.

# 项目文件
File "src/fiat-core/*.v"
File "src/parsers/*.v"
File "src/parsers-examples/*.v"

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

在 _CoqProject.in 文件中，你可以指定项目的名称、描述、版本以及依赖的库和项目文件。这个文件通常需要在项目初始化时创建，并随着项目的更新而维护。