# AGENTS.md

A cross-platform, customizable science fiction terminal emulator with advanced monitoring & touchscreen support.

## Setup

```
npm ci
```

## Commands

```
npm run start                # run the app
npm run test                 # run the test suite, must pass before any commit
npm run install-linux
npm run preinstall-windows
npm run install-windows
npm run prebuild-linux
npm run prebuild-darwin
npm run prebuild-windows
```

## Layout

- `src/` 22 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/build-binaries.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/assets/misc/file-icons-match.js` is 147KB. 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.