# AGENTS.md

Semantic is a UI component framework based around useful principles from natural language.

## Setup

```
npm install
```

## Commands

```
npm run install
```

## Layout

- `tasks/`    38 source files
- `dist/`     22 source files
- `src/`      20 source files
- `test/`     20 source files
- `examples/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `test/coverage/PhantomJS 1.9.2 (Linux)/index.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/semantic.js` is 720KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.