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

GIF command preview in the README #646

Open
veracioux opened this issue Oct 15, 2021 · 3 comments · May be fixed by #647
Open

GIF command preview in the README #646

veracioux opened this issue Oct 15, 2021 · 3 comments · May be fixed by #647
Labels
documentation enhancement

Comments

@veracioux
Copy link

veracioux commented Oct 15, 2021 •
edited

Is your feature request related to a problem? Please describe.
No, just eye candy for the README. Many READMEs of CLI programs show a gif of the command in action. That makes the README more attractive. I'd like to make a live demo that can be uploaded to asciinema and included in the README so everyone can see it when they open this repo.

Describe the solution you'd like
I'd like to turn the example section of the README into a live gif (or svg video) demonstration. The video can be hosted on asciinema.org for free and displayed in the README. The way I'd like to do it is using a program called tuterm (Alert: self-promotion). This program takes a transcript of commands and then reproduces them as if a human were typing them into the terminal.

Describe alternatives you've considered
You could just type out the commands yourself in the terminal and record them using the asciinema program. But if you want to change the behavior of cheat some time in the future, it's always easier to run a simple tuterm script than to type out the command(s) yourself.

How I can help
I would like to create the tuterm script that will run the demo and submit a PR. You can then run the script in whichever terminal you like, using the prompt and color scheme you like. After that, you'll just need to upload it to asciinema.org using another simple command. Note: you will need to install asciinema and tuterm on your system.

I hope you don't mind the self-promotion. I'm on a quest to convince people to use the CLI wherever possible and will employ any means to achieve that 😃.
@chrisallenlane
Copy link
Member

Hi, @veracioux

Thanks for reaching out with the feature request.

I'd welcome this PR. Doing something along these lines has been on my mind for a while now, but I've never had the time.

Generally speaking, the docs are due for an overhaul as well. That's something I hope to address within the next few weeks. Integrating this would segue nicely with that effort.

Do you have a "script" in mind for what you would like to showcase, or would you like some input/assistance there? FWIW, my instincts would probably just be to showcase the "important" functionality, like listing sheets, reading a sheet, adding/editing a sheet, and searching sheets. That said, I've put very little thought into this. lol.

Please let me know if and how I can assist.

Thanks!

@veracioux
Copy link
Author

@chrisallenlane Yeah, I think only the most important features should be on top of the README. I'll create a PR in the coming days. Depending on how it turns out, we can also think about adding a more detailed demonstrations/tutorials.

@chrisallenlane
Copy link
Member

Sounds great, @veracioux. I look forward to the PR. Let me know if I can lend a hand.

Thanks!

@veracioux veracioux linked a pull request Oct 17, 2021 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add tuterm tutorial/demo veracioux/cheat
2 participants
@chrisallenlane @veracioux