diff --git a/Makefile b/Makefile index f93ffec..2ce71f3 100644 --- a/Makefile +++ b/Makefile @@ -22,9 +22,10 @@ install: uninstall: rm ~/bin/viv -docs: docs/demo.gif +docs: docs/demo.gif docs/freeze.gif docs/%.gif: docs/%.tape + viv rm $$(viv l -q) vhs < $< EXAMPLES = cli.py sys_path.py exe_specific.py frozen_import.py named_env.py scrape.py diff --git a/docs/freeze.tape b/docs/freeze.tape new file mode 100644 index 0000000..c057047 --- /dev/null +++ b/docs/freeze.tape @@ -0,0 +1,20 @@ +Set Height 750 +Set Width 1500 +Set Theme "Catppuccin Mocha" +Output ./docs/freeze.gif + +Type "viv list" +Enter +Sleep 2s +Type "viv freeze requests bs4" +Enter +Sleep 5s +Type "viv list" +Enter +Sleep 3s +Type "viv freeze requests bs4 --keep --path relative" +Enter +Sleep 5s +Type "viv list" +Enter +Sleep 5s diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..11fffd7 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,11 @@ +# Usage + +*NOTE*: these demo gif's are a work in progress. If you'd like to see them you can run `vhs` locally with `make docs`. + +# Demo + +demo + +# Freeze + +demo