# AGENTS.md

A community-maintained Python framework for creating mathematical animations. 

## Setup

```
uv sync
```

## Commands

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

## Layout

- `manim/`          169 source files
- `tests/`          157 source files
- `example_scenes/` 4 source files
- `scripts/`        4 source files
- `docs/`           3 source files
- `benchmarks/`     1 source file

## Conventions

- Tests live alongside the code they cover, following `manim/renderer/shaders/test/frag.glsl`.
- CI defines what passing means. See `.github/workflows/cffconvert.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `manim/mobject/graphing/coordinate_systems.py` is 119KB. 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.