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.

Sign up for GitHub

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

Jump to bottom

Better gif/svg animation of starcli usage/demo #80

Open
hedyhli opened this issue Aug 19, 2020 · 7 comments · May be fixed by #88
Open

Better gif/svg animation of starcli usage/demo #80

hedyhli opened this issue Aug 19, 2020 · 7 comments · May be fixed by #88
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers to try help wanted Extra attention is needed

Comments

@hedyhli
Copy link
Owner

hedyhli commented Aug 19, 2020

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 hedyhli added documentation Improvements or additions to documentation good first issue Good for newcomers to try labels Aug 19, 2020
@hedyhli hedyhli added the help wanted Extra attention is needed label Aug 29, 2020
@rachittshah
Copy link

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

@hedyhli
Copy link
Owner Author

hedyhli commented Sep 5, 2020

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

@rachittshah
Copy link

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

@hedyhli
Copy link
Owner Author

hedyhli commented Sep 24, 2020

hello @godslayer201 any updates or questions about this?

@rachittshah
Copy link

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?

@hedyhli
Copy link
Owner Author

hedyhli commented Sep 24, 2020

sure, no worries just checking

@hedyhli hedyhli linked a pull request Feb 16, 2021 that will close this issue
New demo gif #88
Open
4 tasks
@Taki431
Copy link

Taki431 commented Dec 11, 2021

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers to try help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New demo gif sameeravithanage/starcli
3 participants
@Taki431 @hedyhli @rachittshah