# AGENTS.md

An open-source remote desktop application designed for self-hosting, as an alternative to TeamViewer.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `flutter/`  176 source files
- `src/`      141 source files
- `libs/`     112 source files
- `res/`      25 source files
- `examples/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `flutter/test/autocomplete_peer_merge_test.dart`.
- CI defines what passing means. See `.github/workflows/bridge.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/server/connection.rs` is 302KB. 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.