# AGENTS.md

real time face swap and one-click video deepfake with only a single image

## Setup

```
pip install -r requirements.txt
```

## Commands

```
ruff check .   # lint
```

## Layout

- `modules/` 31 source files
- `tests/`   2 source files

## Conventions

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

## Gotchas

- 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.