Hauora Sans 开源项目使用教程
1. 项目目录结构及介绍
Hauora Sans 项目的目录结构如下:
Hauora-Sans/
├── docs/
├── fonts/
├── scripts/
├── sources/
├── .gitignore
├── init-stamp
├── templaterc.json
├── AUTHORS.txt
├── CONTRIBUTORS.txt
├── Makefile
├── OFL.txt
├── README.md
├── index.html
└── requirements.txt
目录介绍:
- docs/: 存放项目文档的目录。
- fonts/: 存放字体文件的目录。
- scripts/: 存放项目脚本的目录。
- sources/: 存放项目源代码的目录。
- .gitignore: Git 忽略文件配置。
- init-stamp: 初始化标记文件。
- templaterc.json: 模板配置文件。
- AUTHORS.txt: 项目作者列表。
- CONTRIBUTORS.txt: 项目贡献者列表。
- Makefile: 项目构建文件。
- OFL.txt: 字体许可证文件。
- README.md: 项目介绍和使用说明。
- index.html: 项目主页文件。
- requirements.txt: 项目依赖文件。
2. 项目启动文件介绍
Hauora Sans 项目没有明确的启动文件,因为它是一个字体设计项目,主要通过字体文件和相关脚本来使用。如果需要生成字体文件,可以使用 Makefile
中的相关命令。
使用 Makefile
生成字体文件:
make fonts
3. 项目配置文件介绍
3.1 templaterc.json
templaterc.json
是一个模板配置文件,用于定义项目中的模板设置。具体内容如下:
{
"template_name": "Hauora Sans",
"version": "1.0.0",
"author": "WCYS-Co",
"license": "OFL-1.1"
}
3.2 requirements.txt
requirements.txt
文件列出了项目所需的依赖项。内容如下:
fontmake==2.0.0
fonttools==4.28.5
3.3 .gitignore
.gitignore
文件用于指定 Git 忽略的文件和目录。内容如下:
*.pyc
*.pyo
*.pyd
__pycache__/
*.DS_Store
*.log
*.tmp
*.swp
*.bak
*.orig
*.rej
*.pyc
*.pyo
*.pyd
*.egg-info/
*.dist-info/
*.pyc
*.pyo
*.pyd
*.egg-info/
*.dist-info/
*.pyc
*.pyo
*.pyd
*.egg-info/
*.dist-info/
通过以上介绍,您可以更好地理解和使用 Hauora Sans 开源项目。