Git/cheat
1
0
Fork 0
mirror of https://github.com/cheat/cheat.git synced 2024-11-23 22:41:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
9b3ace6954
cheat/doc/demo
History
Haris Gušić 9b3ace6954 Add upload script and svg 
Signed-off-by: Haris Gušić <harisgusic.dev@gmail.com>
2021-11-02 18:51:08 +01:00
..
asciinema_upload_and_create_svg.sh Add upload script and svg 2021-11-02 18:51:08 +01:00
cheat_demo.svg Add upload script and svg 2021-11-02 18:51:08 +01:00
cheat.tut Disable status bar in tmux 2021-11-02 18:25:30 +01:00
README.md Add upload script and svg 2021-11-02 18:51:08 +01:00

README.md

Automated demo/interactive tutorial

Tuterm is used to create a fully automated real-time demonstration of the program. The demonstration is generated from the script cheat.tut, and it can be played in the terminal by running tuterm -m demo cheat.tut.

To upload the demonstration, run ./asciinema_upload_and_create_svg.sh. This script will upload to asciinema and give you back the URL, and create the SVG file cheat_demo.svg, both of which are meant to be included in the README.md. The SVG file should be included in version control. If you open the script, you will find some tweakable parameters.

The cheat.tut can also serve as an interactive tutorial, if you run tuterm cheat.tut.