Hanken Grotesk 开源项目使用教程

Hanken Grotesk 开源项目使用教程

hanken-grotesk This is a repository of Open Source files of the Hanken Grotesk typeface. 项目地址: https://gitcode.com/gh_mirrors/ha/hanken-grotesk

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

Hanken Grotesk 项目的目录结构如下：

hanken-grotesk/
├── AUTHORS.txt
├── CONTRIBUTORS.txt
├── OFL.txt
├── README.md
├── requirements.txt
├── github/
│   └── workflows/
├── fonts/
├── images/
├── sources/
├── .gitattributes
└── .gitignore

目录结构介绍

• AUTHORS.txt: 项目作者信息文件。
• CONTRIBUTORS.txt: 项目贡献者信息文件。
• OFL.txt: 开源字体许可证文件。
• README.md: 项目介绍和使用说明文件。
• requirements.txt: 项目依赖的 Python 包列表。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• fonts/: 存放生成的字体文件。
• images/: 存放项目相关的图片文件。
• sources/: 存放字体源文件和构建脚本。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

Hanken Grotesk 项目的主要启动文件是 sources/ 目录下的构建脚本。这些脚本用于生成字体文件。

启动文件介绍

• sources/gftools-builder.yml: 这是字体构建的配置文件，使用 gftools 工具进行字体构建。

启动步骤

1. 进入项目目录：

   cd your/local/project/directory
   

2. 创建并激活虚拟环境：

   python3 -m venv venv
   source venv/bin/activate
   

3. 安装依赖包：

   pip install -r requirements.txt
   

4. 运行构建脚本：

   cd sources
   gftools builder config.yml
   

3. 项目的配置文件介绍

Hanken Grotesk 项目的主要配置文件是 sources/gftools-builder.yml。

配置文件介绍

• sources/gftools-builder.yml: 该文件定义了字体构建的配置，包括字体源文件的路径、输出路径、字体特性等。

配置文件示例

# sources/gftools-builder.yml
sources:
  - path: ./path/to/source/files
output:
  - path: ./path/to/output/fonts
features:
  - name: 'liga'
    enable: true
  - name: 'kern'
    enable: true

通过以上配置，可以自定义字体的构建过程，生成符合需求的字体文件。

hanken-grotesk This is a repository of Open Source files of the Hanken Grotesk typeface. 项目地址: https://gitcode.com/gh_mirrors/ha/hanken-grotesk