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

Refresh README examples #50

Closed
bradlarsen opened this issue May 4, 2023 · 3 comments
Closed

Refresh README examples #50

bradlarsen opened this issue May 4, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@bradlarsen
Copy link
Collaborator

The example snippets and usage instructions in the README are out-of-date now. They could also stand to be generally improved.

Some ideal properties of the example usage snippets:

  • they can be automatically regenerated from a script
  • they include short animation screen captures, in addition to static terminal command/output text

Useful references:

@bradlarsen bradlarsen added the documentation Improvements or additions to documentation label May 4, 2023
@bradlarsen
Copy link
Collaborator Author

Note, terminalizer is half implemented and crashes when generated gifs for me. I have had much better luck using asciinema for recording and agg for rendering.

@bradlarsen bradlarsen added this to the v0.15.0 milestone Aug 23, 2023
@bradlarsen bradlarsen removed this from the v0.15.0 milestone Jan 18, 2024
@bradlarsen
Copy link
Collaborator Author

Another tool for terminal session recording, screenshot capture, and gif creation: https://github.com/charmbracelet/vhs

@bradlarsen
Copy link
Collaborator Author

I ended up using vhs for creating some example GIFs in #154. That works usably well. The project is cool, but has a lot of significant bugs in it.

The most robust combination of tools I've tried for scripting and recording terminal sessions is demo-magic for scripting, asciinema for recording, and agg for rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant