17 lines
1,000 B
Markdown
17 lines
1,000 B
Markdown
---
|
|
applyTo: "**"
|
|
---
|
|
|
|
# Custom Font Homebrew Tap — Project instructions
|
|
|
|
**For full context, read [PROJECT.md](../PROJECT.md) at the repo root.**
|
|
|
|
## What this repo is
|
|
- Homebrew tap for a personal font collection. Users run `brew tap ...` then `brew install font-<name>`.
|
|
- Fonts live in `font_files/font-<name>/` with exactly four subdirs: `ttf/`, `otf/`, `web/`, `other_files/`.
|
|
|
|
## Rules
|
|
- Do **not** edit `Formula/*.rb` by hand. They are generated by `.fontfoldercleanup/create_homebrew_formula.py`.
|
|
- To add a font: run `uv run add-font <path_or_name>` (or add folder `font_files/font-<name>/`, run `cleanup_font_folders.py` then `create_homebrew_formula.py`). Validate with `uv run pytest tests/`.
|
|
- Scripts: Python 3 in `.fontfoldercleanup/` (cleanup_font_folders.py, create_homebrew_formula.py). CLI: `uv run add-font`. Tests: `uv run pytest tests/`.
|
|
- All font folders must use the `font-` prefix; only `.ttf` in ttf/, `.otf` in otf/, web fonts in web/, everything else in other_files/.
|