aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-02 20:53:32 +0200
committerDanilo M. <danix@danix.xyz>2026-10-02 20:53:32 +0200
commit5c5d338938e286a5a24048186d79e36b192fbe56 (patch)
tree0a073791809f650bc7a5f14b5048e5e3e6e86d12 /README.md
parent0687e489e0e2b273f8c3c466ad77cb2066bc168f (diff)
downloadak820-upload-master.tar.gz
ak820-upload-master.zip
Add --gif option to write a preview GIFHEADmaster
Runs the same crop/scale/fps/frame-cap ffmpeg chain to a GIF file instead of uploading, so the result can be previewed or shared. Replaces the separate video2ak820 script. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.