# AGENTS.md

If you live in the terminal, kitty is made for you! Cross-platform, fast, feature-rich, GPU based.

## Setup

```
go mod download
```

## Commands

```
make test               # run the test suite, must pass before any commit
make clean
make debug
make debug-event-loop
make asan
make profile
```

## Layout

- `kitty/`       249 source files
- `tools/`       226 source files
- `kittens/`     175 source files
- `glfw/`        67 source files
- `3rdparty/`    55 source files
- `kitty_tests/` 38 source files

## Conventions

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

## Gotchas

- `kitty/char-props-data.h` is 911KB. 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.