Better gif/svg animation of starcli usage/demo
hedyhli opened this issue · 7 comments
The latest usage gif was outdated and since then there were new features and bug fixes. We should provide a new, up-to-date when to show the full features.
Requirements:
- Shouldn’t be too slow, it is recommended that it is sped up, but users should see clearly what is happening
- No need to show all the features, but show as much as possible
- It should be run like a user who downloaded it as a package using
starcli <args>notpython -m starcli.
To do so you have several options:- clone this repo and do
python setup.py install - Make a new directory in a virtual environment and use
pip install starcli(or you favourite package manager) - Install starcli globally as a package like a normal user would
- clone this repo and do
- Once you have your SVG (or gif) saved, put it in the images folder (replace the original gif), update the link in the README and push to remote to open a PR
Some tools you could use:
- asciinema for terminal session recordings
- How to speed up and Asciinema recording
- Turn asciinema cast into clear, pretty SVGs
If you would like to work on this, there is no need to ask, just open a PR. If there are multiple, I will choose one that works best or even include all of them
hello,I would like to work on this issue, Would including only the help in the gif be alright?
Thanks for your interest, but not including the features and the different outputs will make no use of the gif as the help usage is already in the readme. Please read the issue description. The reason for the gif is so that users can get a sense of how the output looks and feels like
Sure,I'll try to optimize it and push a PR. Thank you for the help,will keep all the features in mind.
hello @godslayer201 any updates or questions about this?
hello @godslayer201 any updates or questions about this?
Hello, apologies for the delay.
I was unwell recently, I would work on this over the weekend?
sure, no worries just checking