diff --git a/README.md b/README.md index 954a568..29d1c6b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # specgetty +![specgetty demo](demo.gif) + Do you work with multiple projects that use OpenSpec for managing specifications? Have you ever lost track of which OpenSpec projects exist on your local machine @@ -46,3 +48,11 @@ Simple key navigation in the UI as follows: ```bash make lint ``` + +### Generating the preview GIF + +The preview GIF is generated using [VHS](https://github.com/charmbracelet/vhs): + +```bash +vhs demo.tape +``` diff --git a/demo.tape b/demo.tape new file mode 100644 index 0000000..3435e99 --- /dev/null +++ b/demo.tape @@ -0,0 +1,62 @@ +# VHS tape file for specgetty preview GIF +# Run with: vhs demo.tape + +Output demo.gif + +Require spg + +Set Shell "bash" +Set FontSize 14 +Set Width 1200 +Set Height 600 +Set Padding 10 +Set Theme "Catppuccin Mocha" + +# Launch specgetty pointing at the demo openspec project +Type "spg ." +Enter +Sleep 3s + +# Navigate down through the project list +Down +Sleep 1s +Down +Sleep 1s + +# Switch focus to the detail panel +Tab +Sleep 1.5s + +# Scroll down inside the detail view +Down +Sleep 0.5s +Down +Sleep 0.5s +Down +Sleep 1s + +# Switch to the changes tab +Right +Sleep 1.5s + +# Switch to the archive tab +Right +Sleep 1.5s + +# Switch to the config tab +Right +Sleep 1.5s + +# Switch back to specs tab +Left +Left +Left +Sleep 1s + +# Switch focus back to project list +Tab +Sleep 1s + +# Quit +Type "q" +Sleep 1s