# AGENTS.md

🎥 Command line media player

## Setup

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

## Commands

```
ruff check .   # lint
```

## Layout

- `osdep/`  78 source files
- `video/`  47 source files
- `player/` 43 source files
- `demux/`  36 source files
- `misc/`   36 source files
- `TOOLS/`  31 source files

## Conventions

- Tests live alongside the code they cover, following `TOOLS/lua/audio-hotplug-test.lua`.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `player/command.c` is 286KB. 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.