Skip to content

Add a recorded demo GIF and screenshot to the README - #2

Merged
skunkworker merged 1 commit into
masterfrom
readme-demo-assets
Aug 17, 2026
Merged

Add a recorded demo GIF and screenshot to the README#2
skunkworker merged 1 commit into
masterfrom
readme-demo-assets

Conversation

@skunkworker

Copy link
Copy Markdown
Owner

The README described the TUI without showing it. Add both assets plus the tooling to regenerate them, so they can be refreshed after a UI change rather than going stale.

assets/make-demo-repo.sh builds a throwaway repo with branches in every state git_pruner distinguishes — merged, stale upstream, ahead of upstream, no upstream — with backdated commits so the relative-date column reads naturally. The stale upstreams are deleted inside the bare remote rather than with push --delete, which would also drop the local remote-tracking refs and make the branches read as gone before the demo runs; leaving them unpruned is what gives p something to reveal.

The two vhs tapes share their terminal settings and setup via common.tape, since the GIF and the still sit side by side in the README and would look mismatched if the width or theme drifted. Both record against a single build of the demo repo so their commit hashes agree.

record.sh deletes the still before recording and fails if vhs did not write it: vhs has been observed to skip a Screenshot and still exit 0, which would silently ship the previous image. The capture is quantised to a 256-colour palette, which is visually indistinguishable for terminal text at a third of the size.

Also record two UI bugs the demo surfaced in docs/improvements.md: the cursor starts on an arbitrary row, and the confirmation screen reports gone branches as unmerged even when their tip was merged before the upstream was deleted.

The README described the TUI without showing it. Add both assets plus the
tooling to regenerate them, so they can be refreshed after a UI change rather
than going stale.

assets/make-demo-repo.sh builds a throwaway repo with branches in every state
git_pruner distinguishes — merged, stale upstream, ahead of upstream, no
upstream — with backdated commits so the relative-date column reads naturally.
The stale upstreams are deleted inside the bare remote rather than with
`push --delete`, which would also drop the local remote-tracking refs and make
the branches read as gone before the demo runs; leaving them unpruned is what
gives `p` something to reveal.

The two vhs tapes share their terminal settings and setup via common.tape,
since the GIF and the still sit side by side in the README and would look
mismatched if the width or theme drifted. Both record against a single build of
the demo repo so their commit hashes agree.

record.sh deletes the still before recording and fails if vhs did not write it:
vhs has been observed to skip a Screenshot and still exit 0, which would
silently ship the previous image. The capture is quantised to a 256-colour
palette, which is visually indistinguishable for terminal text at a third of
the size.

Also record two UI bugs the demo surfaced in docs/improvements.md: the cursor
starts on an arbitrary row, and the confirmation screen reports gone branches
as unmerged even when their tip was merged before the upstream was deleted.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@skunkworker
skunkworker merged commit e692903 into master Aug 17, 2026
2 checks passed
@skunkworker
skunkworker deleted the readme-demo-assets branch August 17, 2026 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant