hedyhli / hedyhli/starcli

Better gif/svg animation of starcli usage/demo

Open
#80 7 comments 0 reactions 0 assignees Claimed by @sameeravithanage View on GitHub
documentation good first issue help wanted
Dominant language
Python
Stars
581
Forks
56
PR merge metrics
No merged PRs in 30d

Description

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 ` 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:**
* [asciinema](https://asciinema.org) for terminal session recordings
* [How to speed up and Asciinema recording](https://stackoverflow.com/questions/57615791/speed-up-asciinema-by-editing-file)
* [Turn asciinema cast into clear, pretty SVGs](https://github.com/marionebl/svg-term-cli)

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.