# AGENTS.md

OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched

## Setup

```
uv sync
```

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `tests/`   83 source files
- `src/`     79 source files
- `misc/`    11 source files
- `bin/`     1 source file
- `docs/`    1 source file
- `scripts/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/__init__.py`.
- 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.

---

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.