Skip to content
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,12 @@ python -m venv .venv

The build downloads Klee One Regular from the pinned commit of [fontworks-fonts/Klee](https://github.com/fontworks-fonts/Klee) (`8b05327`) and verifies its SHA-256 before use. The Full edition also downloads the checksum-pinned LXGW WenKai 1.530 Light release. Its outlines and layout dependencies supply only missing public code points; donor private-use entries and variation sequences are excluded. Imported ideographs are eroded to the stroke width Klee's density model predicts; advances and vertical origins stay, and shared glyphs are untouched ([weight notes](docs/weight.md)). `sources/glyphs/` holds the historical outlines as SVG in a 1000-unit em, y down, em top at y=880. `check.py` shapes the built fonts with HarfBuzz: default glyphs, every feature in both writing directions, mark composition, small-kana vertical origins, and byte identity of every Klee One glyph in the full font. `specimen/index.html` shows the result. `site/` holds the specimen site and CDN at kureedo.mkpo.li; `site/README.md` describes how a release is published there.

## Sponsor

I build Kureedo on my own, with no funding behind it, and it's free for everyone. If it's useful to you, a tip on [Ko-fi](https://ko-fi.com/mkpoli) or [OFUSE](https://ofuse.me/mkpoli) gives me time to keep improving it. Companies interested in sponsoring can write to mkpoli@mkpo.li.

[![Support me on Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/mkpoli)

## Licence

The fonts are licensed under the SIL Open Font License 1.1 (`OFL.txt`). The Full edition includes LXGW WenKai contributions, Copyright 2021–2026 LXGW; its upstream notice and reserved font names are in `sources/wenkai/OFL.txt` and in the Full font metadata. Distributions of Full must include that notice alongside `OFL.txt`. Klee One is Copyright 2020 The Klee Project Authors; Klee is a trademark of Fontworks Inc., and Kureedo is an independent derivative with no connection to Fontworks. The historical outlines and the scripts in this repository are Copyright 2026 The Kureedo Project Authors; the scripts are released under the MIT License (`LICENSE-scripts.txt`).
Expand Down
1 change: 1 addition & 0 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Static specimen site for Kureedo, served at https://kureedo.mkpo.li on Cloudflare Workers (static assets only, no worker script).
Deploy with `bunx wrangler deploy` from this directory; `public/fonts/` and `public/images/` are copies of `../fonts/` and `../docs/images/`, and `KureedoKanji-Subset.woff2` is `pyftsubset ../fonts/KureedoFull-Regular.ttf --unicodes=U+5B50,U+4E95 --flavor=woff2 --layout-features=''` (the 子 and 井 of the comparison row).
`public/sponsor/` holds the two portrait crops used by the Sponsor pill and dialog in `public/index.html`; `public/brand/kofi-symbol.svg` is the official Ko-fi mark on the dialog's tip button.
The custom domain is declared in `wrangler.jsonc`, so the DNS record is created on deploy.

After a release: update the version, sizes and asset URLs in the download block of `public/index.html` (`gh release view --json tagName,assets`), copy the new webfont into `public/fonts/` (the "latest" alias) and into a new `public/vX.Y.Z/` folder, add `public/vX.Y.Z/kureedo.css` pinned to that folder, point `public/kureedo.css` and the snippets in the ウェブフォント配信 section at the new version, add the `/vX.Y.Z/*` block to `public/_headers`, and regenerate the glyph grids (one per Unicode block, cells Klee One lacks marked) with `../.venv/bin/python scripts/glyphs.py` (it rewrites the block between the `glyphs:start` and `glyphs:end` markers).
Expand Down
13 changes: 13 additions & 0 deletions site/public/brand/kofi-symbol.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading