Repository navigation
The README shows a one-minute recording of installing and running cdclint - #23
Merged
Merged
Conversation
…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.
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
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.
What changes
docs/demo.gif(embedded at the top of the README),docs/demo.mp4(the same recording, for posts and talks), anddocs/demo.tape(the VHS script that records them).checksums.txt, thensha256sum --check(OK)./usr/local/bin;cdclint --versionprintscdclint 0.4.0.brew install avison9/tap/cdclintandgo install.corpus/include-list-typo. It prints the warning and the error from the README's "Try it" section, andexit code: 1.uses: avison9/cdclint@v0for CI.Verified
Rejected
For you
README.mdbefore merging.INSTALLING.md's release-archive example still saysVERSION=0.1.0. That is not touched here.