starcli icon indicating copy to clipboard operation
starcli copied to clipboard

Better gif/svg animation of starcli usage/demo

Open hedyhli opened this issue 4 years ago • 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> not python -m starcli. To do so you have several options:
    1. clone this repo and do python setup.py install
    2. Make a new directory in a virtual environment and use pip install starcli (or you favourite package manager)
    3. Install starcli globally as a package like a normal user would
  • 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:

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

hedyhli avatar Aug 19 '20 08:08 hedyhli

hello,I would like to work on this issue, Would including only the help in the gif be alright?

rachittshah avatar Sep 05 '20 06:09 rachittshah

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

hedyhli avatar Sep 05 '20 06:09 hedyhli

Sure,I'll try to optimize it and push a PR. Thank you for the help,will keep all the features in mind.

rachittshah avatar Sep 05 '20 07:09 rachittshah

hello @godslayer201 any updates or questions about this?

hedyhli avatar Sep 24 '20 08:09 hedyhli

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?

rachittshah avatar Sep 24 '20 08:09 rachittshah

sure, no worries just checking

hedyhli avatar Sep 24 '20 09:09 hedyhli

@hedyhli What's the status for this issue or any ongoing issues? Can I contribute to the issue or any other issues that you need help with? It's my first time contributing, and I'd like to be helpful!

Taki431 avatar Dec 11 '21 09:12 Taki431