27 lines
1.6 KiB
Markdown
27 lines
1.6 KiB
Markdown
---
|
|
name: custom-font-tap-project
|
|
description: Use when working in this repository, when the user asks about fonts, Homebrew formulae, the font tap, adding fonts, or the folder structure in font_files or Formula. Describes a Homebrew tap for custom fonts and the scripts that organize font folders and generate formulae.
|
|
---
|
|
|
|
# Custom Font Tap — Project context
|
|
|
|
**Canonical reference: read [PROJECT.md](../../../PROJECT.md) at the repo root.**
|
|
|
|
## What this repo is
|
|
- A **Homebrew tap** for a personal font collection. Users run `brew tap genet-godzilla/fonts ...` then `brew install font-<name>`.
|
|
- Fonts live in `font_files/font-<name>/` with exactly four subdirectories: `ttf/`, `otf/`, `web/`, `other_files/`.
|
|
|
|
## Rules
|
|
- **Do not edit `Formula/*.rb` by hand.** They are generated by `.fontfoldercleanup/create_homebrew_formula.py`.
|
|
- All font folders must use the `font-` prefix. Only `.ttf` in ttf/, `.otf` in otf/, web fonts (woff, woff2, eot, svg) in web/, everything else in other_files/.
|
|
- To add a font: add `font_files/font-<name>/`, run `cleanup_font_folders.py` then `create_homebrew_formula.py`.
|
|
|
|
## Scripts (Python 3, in `.fontfoldercleanup/`)
|
|
- **cleanup_font_folders.py** — Organizes a directory of font folders into ttf/, otf/, web/, other_files/. Run with `--path <dir>` (e.g. `font_files`).
|
|
- **create_homebrew_formula.py** — Generates `Formula/font-<name>.rb` for every `font-*` folder in `font_files/`.
|
|
|
|
## Quick commands (from repo root)
|
|
```bash
|
|
python3 .fontfoldercleanup/cleanup_font_folders.py --path font_files
|
|
python3 .fontfoldercleanup/create_homebrew_formula.py
|
|
```
|