Add gifs to the README to illustrate functionality#289
Open
ericphanson wants to merge 4 commits into
Open
Conversation
Owner
|
This is pretty cool! I think it's a clear win in terms of usability for newbies. I guess one question is whether this will increase the package size: do the assets get downloaded when you install the package? |
Yes, a snapshot of the entire repository is installed, but all the images in this PR are less than 100 kB each (Edit: apart from one, which is 225 kB 😅). |
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.
I used ProgressMeter as a proving ground for my new package Asciicast.jl which intends to make it easy and maintainable to have animated examples in github READMEs. (The package is not registered, but will be in a couple days).
This PR turns some of the README examples into Asciicast blocks, by adding the syntax
{cast = "true"}to some of the julia code blocks. ThenAsciicast.cast_readme(ProgressMeter)executes them (using the same sandboxes as Documenter) and saves the results as gifs (using agg) to theassetsdirectory, then uses pandoc to insert the image links back into the README.This has the benefit of being easily maintainable, but the drawback that it uses pandoc's opinionated github-flavored markdown formatting, which causes a somewhat large diff here.
I am not sure if this is desired here, but since I was trying out Asciicast with ProgressMeter anyway, I figured I'd make a PR.