Bricolage Grotesque 项目使用教程
1. 项目目录结构及介绍
Bricolage Grotesque 项目的目录结构如下:
bricolage/
├── AUTHORS.txt
├── CONTRIBUTORS.txt
├── Makefile
├── OFL.txt
├── README.md
├── requirements.txt
├── github/
│ └── workflows/
├── fonts/
├── scripts/
└── sources/
目录介绍
- AUTHORS.txt: 项目作者列表。
- CONTRIBUTORS.txt: 项目贡献者列表。
- Makefile: 项目的构建文件,包含构建、测试和生成证明文件的命令。
- OFL.txt: 项目的许可证文件,基于 SIL Open Font License 1.1。
- README.md: 项目的介绍和使用说明。
- requirements.txt: 项目依赖的 Python 包列表。
- github/workflows/: 包含 GitHub Actions 的工作流配置文件。
- fonts/: 存放生成的字体文件。
- scripts/: 包含项目的脚本文件。
- sources/: 存放项目的源代码和资源文件。
2. 项目的启动文件介绍
Bricolage Grotesque 项目的主要启动文件是 Makefile
。通过 Makefile
,你可以执行以下操作:
- 构建字体文件: 使用
make build
命令生成字体文件。 - 运行测试: 使用
make test
命令运行 FontBakery 的质量保证测试。 - 生成证明文件: 使用
make proof
命令生成 HTML 证明文件。
3. 项目的配置文件介绍
Bricolage Grotesque 项目的主要配置文件是 Makefile
和 requirements.txt
。
Makefile
Makefile
包含了项目的构建、测试和生成证明文件的命令。你可以通过以下命令来执行不同的操作:
make build
: 生成字体文件。make test
: 运行 FontBakery 的质量保证测试。make proof
: 生成 HTML 证明文件。
requirements.txt
requirements.txt
列出了项目依赖的 Python 包。你可以使用以下命令来安装这些依赖:
pip install -r requirements.txt
通过这些配置文件,你可以轻松地构建、测试和生成 Bricolage Grotesque 项目的字体文件。