-
Notifications
You must be signed in to change notification settings - Fork 4
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
Use asciinema for demo in readme.md #242
Comments
Hi @kmahajan-cadfem, this is a great suggestion. We considered using this tool some time ago. However, we decided to go with VHS. The reason is that this last tool allows to store the commands in plain text, allowing us to track everything in the VCS. |
However, the font size looks small in the current Gif. Would you like to improve it? |
@jorgepiloto, VHS looks good as well, since this is not a lot of code to type in terminal, it is fine if user cannot copy it. |
What I did some time ago was to create the VHS script. Later, I rendered it into a Gif. Both files are stored in the "_static" directory of the documentation, see: |
@jorgepiloto, seems like you would have to change the Font yourself, unfortunately I tried to do it on windows machine(only have that option),
|
📝 Description of the feature
Using a gif is a great idea to show the functionality of the cli tools.
another great way is to use the asciinema.
This is a great help in user growth.
💡 Steps for implementing the feature
🔗 Useful links and references
https://asciinema.org
The text was updated successfully, but these errors were encountered: