# AGENTS.md

Transforms complex documents like PDFs and Office docs into LLM-ready markdown/JSON for your Agentic workflows.

## Setup

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

## Commands

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

## Layout

- `mineru/` 217 source files
- `tests/`  5 source files
- `demo/`   1 source file

## Conventions

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

## Gotchas

- `mineru/model/docx/docx_converter.py` is 140KB. 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.