Skip to content

Commit 639cb5f

Browse files
committed
add agents.md
1 parent a05115f commit 639cb5f

File tree

2 files changed

+34
-39
lines changed

2 files changed

+34
-39
lines changed

AGENTS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pixer
2+
3+
Cross-platform image manipulation library: Dart API backed by Rust via FFI.
4+
5+
## Project Structure
6+
7+
- `/native` - Rust crate (pixer) with image processing logic
8+
- `/packages/pixer` - Main Dart package with FFI bindings
9+
- `/packages/benchmarks` - Performance benchmarks
10+
- `/packages/upscale_flutter` - Flutter demo app
11+
12+
## Commands
13+
14+
```bash
15+
# Build native library locally
16+
dart tool/build.dart -o<os> -a<arch>
17+
# Examples: -omacos -aarm64, -olinux -ax64, -oandroid -aarm64
18+
19+
# Generate FFI bindings (after changing native/src/ffi.rs)
20+
dart run ffigen --config ffigen.yaml
21+
```
22+
23+
## Release
24+
25+
1. Push changes via PR to `main`
26+
2. Tag and push: `git tag pixer-assets-v1.0.0 && git push origin pixer-assets-v1.0.0`
27+
3. CI builds all platforms and creates GitHub Release
28+
29+
## Architecture
30+
31+
- Rust code in `native/src/`: `lib.rs` (entry), `api.rs` (image ops), `ffi.rs` (C bindings)
32+
- Dart bindings generated via ffigen into `lib/src/bindings/`
33+
- Native assets delivered via Dart build hooks (see `hook/` directory)

CLAUDE.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)