Merge pull request #232 from jacebrowning/asciinema

Record demo with asciinema

.verchew.ini

@@ -24,4 +24,26 @@ cli = dot
 cli_version_arg = -V
 version = 2
 optional = true
-message = This is only needed to generate UML diagrams for documentation.
+message = $ brew install graphviz
+
+[asciinema]
+
+cli = asciinema
+version = 2
+optional = true
+message = $ brew install asciinema
+
+[Gifsicle]
+
+cli = gifsicle
+version = 1
+optional = true
+message = $ brew install gifsicle
+
+[asciicast2gif]
+
+cli = asciicast2gif
+cli_version_arg = help
+version = Generate GIF animations from asciicasts
+optional = true
+message = $ npm install --global asciicast2gif

Makefile

@@ -26,10 +26,35 @@ watch: install .clean-test ## Continuously run all CI tasks when files chanage
 .PHONY: demo
 demo: install
 	poetry run gitman install --force  # some scripts have intentional errors
+ifdef RECORDING
+	@ sleep 2
+	@ clear
+	@ sleep 1
+endif
 	poetry run gitman update --force  # some scripts have intentional errors
+ifdef RECORDING
+	@ sleep 2
+	@ clear
+	@ sleep 1
+endif
 	poetry run gitman list
+ifdef RECORDING
+	@ sleep 2
+	@ clear
+	@ sleep 1
+endif
 	poetry run gitman lock
+ifdef RECORDING
+	@ sleep 2
+	@ clear
+	@ sleep 1
+endif
 	poetry run gitman uninstall
+ifdef RECORDING
+	@ sleep 2
+	@ clear
+	@ sleep 1
+endif
 
 # SYSTEM DEPENDENCIES #########################################################
 
@@ -142,6 +167,13 @@ docs/*.png: $(MODULES)
 	- mv -f classes_$(PACKAGE).png docs/classes.png
 	- mv -f packages_$(PACKAGE).png docs/packages.png
 
+docs/demo.gif: docs/demo.cast
+	asciicast2gif $< $@
+docs/demo.cast:
+	resize -s 30 127
+	poetry run asciinema rec $@ --overwrite --command "make demo RECORDING=true" --title "GitMan Demo"
+	poetry run asciinema upload $@
+
 .PHONY: mkdocs-serve
 mkdocs-serve: mkdocs
 	eval "sleep 3; bin/open http://127.0.0.1:8000" &

README.md

@@ -2,7 +2,7 @@
 
 GitMan is a language-agnostic dependency manager using Git. It aims to serve as a submodules replacement and provides advanced options for managing versions of nested Git repositories.
 
-![demo](https://raw.githubusercontent.com/jacebrowning/gitman/main/docs/demo.gif)
+[![Demo](https://raw.githubusercontent.com/jacebrowning/gitman/main/docs/demo.gif)](https://asciinema.org/a/FKJWRYAkUHcAM5Z1PIbqMOKLk)
 
 [![Unix Build Status](https://img.shields.io/travis/jacebrowning/gitman/master.svg?label=unix)](https://travis-ci.org/jacebrowning/gitman)
 [![Windows Build Status](https://img.shields.io/appveyor/ci/jacebrowning/gitman/master.svg?label=window)](https://ci.appveyor.com/project/jacebrowning/gitman)