# AGENTS.md

Flash OS images to SD cards & USB drives, safely and easily.

## Setup

```
npm install
```

## Commands

```
npm run start      # run the app
npm run test       # run the test suite, must pass before any commit
npm run lint       # lint
npm run prettify
npm run package
npm run make
npm run wdio
```

## Layout

- `lib/`     65 source files
- `tests/`   17 source files
- `typings/` 4 source files

## Conventions

- Tests live alongside the code they cover, following `.github/actions/test/action.yml`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/flowzone.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- 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.