# AGENTS.md

高颜值的第三方网易云播放器，支持 Windows / macOS / Linux :electron: 

## Setup

```
yarn install
```

## Commands

```
yarn build                  # produce a build
yarn lint                   # lint
yarn serve
yarn electron:build
yarn electron:build-all
yarn electron:build-mac
yarn electron:build-win
yarn electron:build-linux
```

## Layout

- `src/` 93 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.yaml`, 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.
- Copy `.env.example` before running anything that needs configuration.

---

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.