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

Use asciinema for demo in readme.md #242

Open
kmahajan-cadfem opened this issue Apr 11, 2023 · 5 comments
Open

Use asciinema for demo in readme.md #242

kmahajan-cadfem opened this issue Apr 11, 2023 · 5 comments
Labels
enhancement New features or code improvements

Comments

@kmahajan-cadfem
Copy link

📝 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

  • replace current GIF with the asciinema link

🔗 Useful links and references

https://asciinema.org

@kmahajan-cadfem kmahajan-cadfem added the enhancement New features or code improvements label Apr 11, 2023
@jorgepiloto
Copy link
Member

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.

@jorgepiloto
Copy link
Member

However, the font size looks small in the current Gif. Would you like to improve it?

@kmahajan-cadfem
Copy link
Author

@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.
I will look into the Font size, is it fine if I directly use VHS, or you should I create a GIF in first case.

@jorgepiloto
Copy link
Member

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:

@kmahajan-cadfem
Copy link
Author

@jorgepiloto, seems like you would have to change the Font yourself, unfortunately I tried to do it on windows machine(only have that option),

  • have to change the clear commands to cls and also prompt has the path (would take much efforts on my side, just to change the font size)
  • output is not so nice as one can see in the current GIF
  • if you want to implement the GH action afterwards, windows based commands are not a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

No branches or pull requests

2 participants