# AGENTS.md

Tesseract Open Source OCR Engine (main repository)

## Setup

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

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `src/`      490 source files
- `unittest/` 85 source files
- `java/`     13 source files
- `include/`  11 source files
- `nsis/`     3 source files
- `doc/`      1 source file

## Conventions

- Tests live alongside the code they cover, following `unittest/apiexample_test.cc`.
- CI defines what passing means. See `.github/workflows/autotools-macos.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/ccutil/universalambigs.h` is 317KB. 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.