# AGENTS.md

Port of OpenAI's Whisper model in C/C++

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make build     # produce a build
make samples
```

## Layout

- `ggml/`     574 source files
- `bindings/` 109 source files
- `examples/` 105 source files
- `scripts/`  22 source files
- `tests/`    22 source files
- `src/`      18 source files

## Conventions

- Tests live alongside the code they cover, following `bindings/go/pkg/whisper/context_test.go`.
- CI defines what passing means. See `.github/workflows/bindings-go.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `examples/miniaudio.h` is 4011KB. 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.