# AGENTS.md

A utility-first CSS framework for rapid UI development.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev                 # run locally
pnpm build               # produce a build
pnpm test                # run the test suite, must pass before any commit
pnpm lint                # lint
pnpm format              # format
pnpm postbuild
pnpm test:integrations
pnpm test:ui
```

## Layout

- `packages/`     260 source files
- `crates/`       62 source files
- `integrations/` 43 source files
- `playgrounds/`  13 source files
- `scripts/`      6 source files

## Conventions

- Tests live alongside the code they cover, following `crates/ignore/tests/gitignore_matched_path_or_any_parents_tests.gitignore`.
- 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

- `packages/tailwindcss/src/utilities.test.ts` is 820KB. 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.