# AGENTS.md

It's a presentation framework based on the power of CSS3 transforms and transitions in modern browsers and inspired by the idea behind prezi.com.

## Setup

```
npm ci
```

## Commands

```
npm run build      # produce a build
npm run test       # run the test suite, must pass before any commit
npm run lint       # lint
npm run all
npm run new-lint
```

## Layout

- `src/`  27 source files
- `test/` 7 source files
- `js/`   1 source file

## Conventions

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

## Gotchas

- `js/impress.js` is 182KB. 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.