# DarkRoom

A cross-platform, non-destructive RAW photo editor for Linux and Android.

**Status:** early. v0.1 is a remote library viewer — see
[docs/milestone-v0.1.md](docs/milestone-v0.1.md).

## Documentation

| Document | Contents |
|---|---|
| [requirements.md](docs/requirements.md) | What the software must do — 122 numbered requirements |
| [architecture.md](docs/architecture.md) | How it is built — crates, GPU pipeline, data model, sync |
| [milestone-v0.1.md](docs/milestone-v0.1.md) | The first buildable milestone |

## Building

Desktop:

```bash
cargo run -p darkroom-desktop
```

Android (containerised toolchain, see [docker/android](docker/android/README.md)):

```bash
./docker/android/build.sh cargo ndk -t arm64-v8a build --release
```

## Current state

Working: workspace, GPU context and compute pass, adaptive Slint shell, Android
cross-compilation of the core crates.

**Not yet working:** the zero-copy display path. The build currently uploads
frames through the CPU, which is exactly what
[ARCH §6.1](docs/architecture.md) forbids — measured at 96% of frame time at
4K. Replacing it is spike S1, the project's highest priority.

```
cargo run -p dr-gpu --example bench --features readback
```

reproduces that measurement.

## Licence

GPL-3.0-or-later.