# AGENTS.md

JavaScript animation engine

## Setup

```
npm ci
```

## Commands

```
npm run dev                  # run locally
npm run build                # produce a build
npm run typecheck            # type check without emitting
npm run dev:test
npm run test:browser
npm run test:node
npm run open:examples
npm run typecheck:examples
```

## Layout

- `dist/`     210 source files
- `src/`      70 source files
- `tests/`    70 source files
- `examples/` 36 source files

## Conventions

- Tests live alongside the code they cover, following `tests/assets/Altinn-DINExp.woff2`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `dist/bundles/anime.umd.js` is 419KB. 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.