docs: animated TUI demo GIF as the README preview#138
Merged
Conversation
Replace the static xfr-ss.png screenshot with a VHS-recorded GIF of the live TUI: a rate-limited (-b 1G) TCP test against a local server showing the real-time throughput graph, per-second speed/RTT/retransmit stats, and the Settings modal. Rendered from docs/demo.tape (reproduce steps in its header); runs in a throwaway HOME so it is deterministic and touches no real config.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the static
xfr-ss.pngscreenshot with a recorded GIF of the live TUI.What it shows
A rate-limited (
-b 1G) TCP test against a localxfr serve— the real-time throughput graph, per-second speed / RTT / retransmit stats and progress bar, then a peek at the Settings modal (theme picker + the new Update check toggle), holding on the live graph.Reproducibility
Rendered with VHS from
docs/demo.tape(steps in its header):The tape launches into a throwaway
HOME, so the demo is deterministic (default theme, no saved prefs) and never touches real config — this is why an earlier draft went grey (a persistedtheme = monochromeleaked in from a prior run).Verified
Every beat checked frame-by-frame (
ffmpegstills): live graph at 8s, Settings + toggle at 15s, final graph hold at 20s — all render with real data in the colorful default theme, no "Loading…"/blank frames, and the GIF ends on the TUI (quit happens off-camera). 20.9s, ~198 KB.