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.

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

Add tuterm tutorial/demo #647

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Add tuterm tutorial/demo #647

wants to merge 7 commits into from

Conversation

veracioux
Copy link

@veracioux veracioux commented Oct 17, 2021

Closes #646.

@chrisallenlane Here's a first draft.

You can run a non-interactive demo as:

tuterm cheat.tut -m demo

You can also run an interactive tutorial as:

tuterm cheat.tut

I have nothing to add to the non-interactive demo in terms of commands. What's
left to do:

  • Some polish to the demo, possibly
  • Customize prompts, delays and colors based on your suggestions
  • Create a script to record and upload to asciinema
  • Create an animation (GIF or SVG) and put it into the README

I recorded the session and uploaded it to asciinema, so you can preview it:

asciicast

Please let me know if you have any {qu,sugg}estions. Make sure to read the
TODO/NOTE comments I added to the file.

Signed-off-by: Haris Gušić <[email protected]>
@veracioux veracioux marked this pull request as draft October 17, 2021 23:31
@chrisallenlane
Copy link
Member

Hi, @veracioux

Sorry for the delay. I've been unexpectedly busy for the past two weeks.

This looks great! Thanks so much for the effort you've put into this. I think it's a wonderful and concise introduction to cheat.

I don't really have any suggestions beyond "ship it."

I see that you have this PR marked as a draft. Let me know when you're happy with it, and I'll merge it. I'm quite happy with it as-is 👍

Thanks!

@veracioux
Copy link
Author

@chrisallenlane I'm glad you're happy with it!

I've made some more changes:

  • Slightly increased delays for some commands which were a bit too fast IMO
  • Added an asciinema_upload_and_create_svg.sh which does exactly what its name says
  • Added an SVG animation in the main README. I hope you don't mind that I plugged my project under the animation. I can remove it if you think it doesn't fit in there.

You should upload the demo to asciinema yourself and give me that URL so I can put it into the README, so that clicking on the svg animation takes you to asciinema. After that change, I say this is ready to be merged.

@veracioux veracioux marked this pull request as ready for review November 2, 2021 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GIF command preview in the README
2 participants