# AGENTS.md

Easily and securely send things from one computer to another :crocodile: :package:

## Setup

```
go mod download
```

## Commands

```
make build        # produce a build
make web-assets
make build-web
make serve
```

## Layout

- `src/`        94 source files
- `web/`        61 source files
- `internal/`   20 source files
- `benchmarks/` 4 source files
- `cmd/`        1 source file
- `scripts/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `internal/cli/help_test.go`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/croc/croc.go` is 125KB. 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.