# AGENTS.md

A cat(1) clone with wings.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `tests/`       114 source files
- `src/`         40 source files
- `examples/`    7 source files
- `build/`       4 source files
- `assets/`      2 source files
- `diagnostics/` 1 source file

## Conventions

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

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `tests/benchmarks/highlighting-speed-src/numpy_test_multiarray.py` is 310KB. It will not fit comfortably in context, so read it in parts.

---

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.