Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: add vhs demo gif #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

Ruesa18
Copy link
Contributor

@Ruesa18 Ruesa18 commented Apr 4, 2023

add a VHS script to create an example gif on how to use the dde command and our examples.

I locally changed the docker image version to 2.6 and fixed the warning for the depricated volume mapping. But I did not add them to this PR since they have nothing to do with the documentation itself.
Those changes are in this PR though. 😉

@Ruesa18 Ruesa18 self-assigned this Apr 4, 2023
@Ruesa18 Ruesa18 requested a review from s4mpl3d April 4, 2023 12:45
@Ruesa18 Ruesa18 changed the title feat: add vhs demo gif Suggestion: add vhs demo gif Apr 4, 2023
@Ruesa18
Copy link
Contributor Author

Ruesa18 commented Apr 17, 2023

This could be a nice touch as a feature. Sadly I can't get Manjaro to install the latest version, even though it is released on archlinux.org/packages :(

@Ruesa18 Ruesa18 force-pushed the feature/documentation-vhs branch from 82ef81b to c723e60 Compare May 22, 2023 08:56
@Ruesa18 Ruesa18 force-pushed the feature/documentation-vhs branch from c723e60 to 55caa30 Compare May 22, 2023 08:57
@Ruesa18
Copy link
Contributor Author

Ruesa18 commented May 22, 2023

This PR now supports version 0.4.0 of vhs. The gif is saved under assets/gif/demo.gif for later use in the README.
In order to run vhs you may enter the examples directory with your shell of choice (after you've installed vhs of course) and run vhs demo.tape. This will re-generate the gif in the assets directory.

I've seen charmbracelet even published a repo for vhs in Github Actions. So we could even generate the demo gifs on each merge into master. That way the documentation would always stay up to date.

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.

2 participants