NUSspli 项目安装与使用教程

1. 项目目录结构及介绍

NUSspli 项目的目录结构如下：

NUSspli/
├── data/
├── include/
├── meta/
├── src/
├── zlib/
├── clang-format
├── gitignore
├── gitmodules
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── build.py
└── sdl.patch

目录介绍：

• data/: 存放项目的数据文件。
• include/: 存放项目的头文件。
• meta/: 存放项目的元数据文件。
• src/: 存放项目的源代码文件。
• zlib/: 存放 zlib 库的相关文件。
• clang-format: 用于代码格式化的配置文件。
• gitignore: Git 忽略文件配置。
• gitmodules: Git 子模块配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目说明文件。
• build.py: 项目构建脚本。
• sdl.patch: SDL 库的补丁文件。

2. 项目的启动文件介绍

NUSspli 项目的启动文件是 build.py。该文件是一个 Python 脚本，用于构建和启动 NUSspli 项目。

启动步骤：

1. 使用 Docker 构建容器：

   docker build -t nussplibuilder .
   

2. 运行构建脚本：

   docker run --rm -v $(PWD):/project nussplibuilder python3 build.py
   

3. 项目的配置文件介绍

NUSspli 项目的主要配置文件是 Makefile。该文件定义了项目的构建规则和依赖关系。

Makefile 配置项：

• all: 默认构建目标，通常包括编译和链接所有源文件。
• clean: 清理构建生成的文件。
• install: 安装构建生成的文件到指定目录。
• test: 运行项目的测试用例。

通过编辑 Makefile，可以自定义项目的构建过程和配置选项。

---

以上是 NUSspli 项目的安装与使用教程，希望对你有所帮助。