Skip to content

The README shows a one-minute recording of installing and running cdclint - #23

Merged
avison9 merged 1 commit into
mainfrom
docs/quickstart-video
Nov 14, 2026
Merged

avison9 merged 1 commit into
mainfrom
docs/quickstart-video

Conversation

@avison9

@avison9 avison9 commented Nov 14, 2026

Copy link
Copy Markdown
Owner

What changes

  • docs/demo.gif (embedded at the top of the README), docs/demo.mp4 (the same recording, for posts and talks), and docs/demo.tape (the VHS script that records them).
  • The recording is 56 seconds:
    1. Download the v0.4.0 Linux archive and checksums.txt, then sha256sum --check (OK).
    2. Extract to /usr/local/bin; cdclint --version prints cdclint 0.4.0.
    3. A caption names brew install avison9/tap/cdclint and go install.
    4. Clone the repository and run cdclint on corpus/include-list-typo. It prints the warning and the error from the README's "Try it" section, and exit code: 1.
    5. A closing caption gives uses: avison9/cdclint@v0 for CI.

Verified

  • Rendered with VHS v0.10.0 in Docker against the real release and a real clone. I checked frames from each scene: the checksum line, the version, and output identical to the README's "Try it" block.
  • I ran the re-record commands in the tape's header, exactly as written, in an empty directory. They produced a 55.9 s MP4 and a GIF.
  • Size: GIF 518 KB, MP4 505 KB.

Rejected

  • Recording the Homebrew path: it needs a Homebrew container and a Go source build, which takes longer than the whole video.
  • Embedding the MP4 in the README: GitHub plays a committed MP4 only as a link, so the GIF is what the README shows.

For you

  • Look at the GIF on the PR's rich diff of README.md before merging.
  • Separately: INSTALLING.md's release-archive example still says VERSION=0.1.0. That is not touched here.

…lint

A new visitor sees, in under a minute, the whole path: download the
v0.4.0 release, check it against checksums.txt, put it on the PATH, and
run it on corpus/include-list-typo, which prints the same error, warning
and exit code 1 the "Try it" section promises.

The recording is made with VHS from docs/demo.tape, committed beside it,
so it can be re-recorded when a release changes the output; the tape's
header has the two commands. It runs against the real release and a
real clone, not a mock, so a broken download or a changed message shows
up in the recording.

The GIF is what the README embeds, because GitHub plays a GIF inline and
an MP4 in a README only as a link or an uploaded attachment; the MP4 is
kept for posts and talks. Together they add about 1 MB to the
repository.

Rejected: recording the Homebrew path. It needs a Homebrew container
and a source build of Go, which takes longer than the whole video; the
tape's caption names brew and go install instead.
@avison9 avison9 self-assigned this Nov 14, 2026
@avison9
avison9 merged commit 766e92e into main Nov 14, 2026
2 checks passed
@avison9
avison9 deleted the docs/quickstart-video branch November 14, 2026 10:38
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