# AGENTS.md

Pure Javascript OCR for more than 100 Languages 📖🎉🖥

## Setup

```
npm ci
```

## Commands

```
npm run start               # run the app
npm run build               # produce a build
npm run test                # run the test suite, must pass before any commit
npm run lint                # lint
npm run profile:tesseract
npm run profile:worker
npm run prepublishOnly
npm run wait
```

## Layout

- `src/`        42 source files
- `scripts/`    5 source files
- `tests/`      5 source files
- `examples/`   4 source files
- `benchmarks/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `tests/.eslintrc`.
- CI defines what passing means. See `.github/workflows/codeql-analysis.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.