# AGENTS.md

bluetooth mesh chat, IRC vibes

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `bitchat/`               269 source files
- `bitchatTests/`          203 source files
- `localPackages/`         55 source files
- `scripts/`               6 source files
- `bitchatShareExtension/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `localPackages/BitFoundation/Tests/BitFoundationTests/AnnounceV2PacketTests.swift`.
- CI defines what passing means. See `.github/workflows/arti-provenance.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `bitchat/Services/BLE/BLEService.swift` is 315KB. It will not fit comfortably in context, so read it in parts.
- 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.