# AGENTS.md

Materialize, a CSS Framework based on Material Design

## Setup

```
npm ci
```

## Commands

```
npm run dev         # run locally
npm run test        # run the test suite, must pass before any commit
npm run precommit
```

## Layout

- `js/`        28 source files
- `tests/`     15 source files
- `docs/`      3 source files
- `templates/` 3 source files
- `dist/`      1 source file
- `extras/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `test/html/badges.html`.
- 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/js/materialize.js` is 362KB. 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.