Skip to content

README.md

Latest commit

 

History

History
115 lines (82 loc) · 4.62 KB

README.md

File metadata and controls

115 lines (82 loc) · 4.62 KB
Raw

typekernel

用代码写成熟字族的光学 / 设计语义内核 — optical design-semantics kernel for fonts-as-code.
Depends on fontTools; does not rebuild OpenType tables.

自建设计层，编译层坐在 fontTools 上。不是编辑器，不是又一个 fontmake 包装器。

架构入口：docs/ARCHITECTURE.md — 三层分离、公开契约与设计边界。实现与评审以该文为准。

一眼看懂

typekernel 概览：几何、光学、字重

几何 → 光学外扩 → 字重用点位移（不是涂粗）。

是什么 / 不是什么

是 不是
可编程的几何核 + 光学原语（overshoot、stem、对比、接合） Glyphs / FontForge 式 GUI
字重 / 轴作为 designed deltas 的语义层 「描边膨胀 = 字重」的脚本合集
导出到 UFO / designspace，再经 fontTools 编译 重造 OT 表、TTX、varLib、feaLib
日后给 oh-my-font（LihuiT / zayJu）与其他项目复用的地基 成品字族发行仓

安装

尚未发到 PyPI，从源码装：

git clone https://github.com/SheathedSharp/typekernel
cd typekernel
pip install -e ".[compile,specimen]"

可选 extras：compile（ufoLib2 / fontmake / ufo2ft，出 OTF/TTF/VF）、 specimen（Pillow，出 PNG 样张）、boolean（skia-pathops，曲线布尔）、 dev（pytest / ruff / mypy）。

快速开始

按 docs/ARCHITECTURE.md 的标准工作流：

tk new myface --starter latin-sans
cd myface
# 改 system.py → 看控制字 → 扩字组 → tk audit → spacing.py → 母版 →
tk build .
tk proof control .
tk audit .

最小可跑示例：examples/latin_sans_quickstart/（脚手架 + 出 OTF + 控制样张）。
Geo 层示范（不经 starter）：examples/zayju_letter/。

也可以直接调 API：

# 项目内（tk new 之后）：system.py + glyphs/*.py + font.py
from typekernel.cli.build import build_project
from typekernel.cli.new import create_project

root = create_project("demo", parent="/tmp", starter="latin-sans")
font, result = build_project(root, formats=("otf",))
print(result.binaries["otf"])

分层

geo / draw  →  system / project / plugins  →  font / compile (fontTools)
片段与轮廓        System + @glyph + 角点/端点插件      Glyph / Font → UFO / OTF / VF

字母几何写在项目里（starter 或 tk new 生成的项目），不进内核。

状态

版本仍是 0.0.0。已落地：

  • 几何核（typekernel.geo）— 三次曲线轮廓、路径构建、笔桥
  • 绘图（typekernel.draw）— Writer / Fragment / Drawing、角点槽、overlap 构造
  • System / Project（typekernel.system / typekernel.project）— 设计数值表、@glyph、母版求值
  • 插件（typekernel.plugins）— corners / ends / passes（plain、overshoot、diagonal_comp…）
  • 光学原语（typekernel.optics）— overshoot、stem 测量、光学间距
  • 字体模型（typekernel.font）— Font / Glyph / kerning；从 System 推度量
  • CLI — tk new / tk build / tk proof / tk audit / tk diff
  • Starter — latin-sans / latin-humanist-italic（满 ASCII + spacing + Light/Bold VF）；latin-chancery（满 ASCII + pen_dot/flourish，斜体 System.slant）。结构示例而已，字形尚未通过视觉评审，不要当作字形质量范本。

校样（typekernel.qa.proof）— 从编译后的字体路径排瀑布、间距串、字偶对与字符网格。

文档

文件 内容
docs/ARCHITECTURE.md 架构、公开契约、设计边界（先读这个）
docs/VISION.md 要解决什么、成功长什么样
docs/dev-standards.md 提交规范、类型、几何原则、公开 API 纪律
docs/agent-recipes.md 给 coding agent 的用法索引
.agents/skills/typekernel-font-design/ 用 typekernel 设计字体的 agent 说明书
approvals/README.md 人工评审门禁记录的格式与现有条目

开发

pip install -e ".[dev,specimen,compile]"
pytest -q
ruff check src tests
mypy -p typekernel

三条都应在你要发布的提交上通过。细节见 CONTRIBUTING.md。

许可证

MIT © zayju