aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 680e683..7e5fb89 100644
--- a/README.md
+++ b/README.md
@@ -20,9 +20,13 @@ to switch pages).
```sh
cargo build --release
-./target/release/ak820-upload <image|gif|video> [fps]
+./target/release/ak820-upload [--gif out.gif] <image|gif|video> [fps]
```
+`--gif out.gif` writes exactly what would be uploaded (same crop, scale,
+frame rate and frame cap) as a GIF for previewing or sharing, and does not
+touch the keyboard.
+
`fps` defaults to 15 and must be between 2 and 50: the keyboard stores each
frame's delay in 2 ms units in one byte, so no frame can last longer than
about 510 ms. At 15 fps the 255-frame limit gives about 17 seconds.