# AGENTS.md

Iconic font aggregator, collection, & patcher. 3,600+ icons, 50+ patched fonts: Hack, Source Code Pro, more. Glyph collections: Font Awesome, Material Design Icons, Octicons, & more

## Setup

```
npm install
```

## Commands

```
npm run test   # run the test suite, must pass before any commit
```

## Layout

- `bin/` 45 source files
- `src/` 12 source files

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- CI defines what passing means. See `.github/workflows/casks.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `bin/scripts/lib/i_md.sh` is 222KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.