# AGENTS.md

 This project is dedicated to collecting high-quality macOS software and organizing them systematically by different categories for easy search and use.

## Setup

```
npm install
```

## Commands

```
npm run start        # run the app
npm run build        # produce a build
npm run doc
npm run create:ast
npm run feed
```

## Layout

- `build/` 2 source files

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- 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

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- 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.