mirror of
https://github.com/daylinmorgan/viv.git
synced 2024-12-22 10:40:44 -06:00
docs: make more vhs tapes
This commit is contained in:
parent
9b5296036d
commit
ff110f0829
5 changed files with 50 additions and 7 deletions
6
Makefile
6
Makefile
|
@ -22,11 +22,13 @@ install: ## symlink to $PREFIX
|
||||||
uninstall: ## delete $(PREFIX)/viv
|
uninstall: ## delete $(PREFIX)/viv
|
||||||
rm $(PREFIX)/viv
|
rm $(PREFIX)/viv
|
||||||
|
|
||||||
docs: docs/demo.gif docs/freeze.gif ## generate usage examples
|
TAPES = demo freeze list-info-rm
|
||||||
|
GIFS := $(foreach n, $(TAPES), docs/$(n).gif)
|
||||||
|
docs: $(GIFS) ## generate usage examples
|
||||||
|
|
||||||
docs/%.gif: docs/%.tape
|
docs/%.gif: docs/%.tape
|
||||||
viv rm $$(viv l -q)
|
viv rm $$(viv l -q)
|
||||||
vhs < $<
|
cd docs; vhs < $*.tape
|
||||||
|
|
||||||
clean: ## remove build artifacts
|
clean: ## remove build artifacts
|
||||||
rm -rf {build,dist}
|
rm -rf {build,dist}
|
||||||
|
|
11
docs/demo.py
Normal file
11
docs/demo.py
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
__import__("viv").activate("pyfiglet==0.8.post1") # noqa
|
||||||
|
|
||||||
|
from pyfiglet import Figlet
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
f = Figlet(font="slant")
|
||||||
|
figtxt = f.renderText("viv").splitlines()
|
||||||
|
figtxt[-2] += " isn't venv!"
|
||||||
|
print("\n".join(figtxt))
|
|
@ -1,12 +1,12 @@
|
||||||
Set Height 750
|
Set Height 750
|
||||||
Set Width 1500
|
Set Width 1500
|
||||||
Set Theme "Catppuccin Mocha"
|
Set Theme "Catppuccin Mocha"
|
||||||
Output ./docs/demo.gif
|
Output ./demo.gif
|
||||||
|
|
||||||
Type "viv list"
|
Type "viv list"
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
Type "python examples/cli.py --help"
|
Type "python ../examples/cli.py --help"
|
||||||
Enter
|
Enter
|
||||||
Sleep 10s
|
Sleep 10s
|
||||||
Type "viv list"
|
Type "viv list"
|
||||||
|
@ -15,9 +15,9 @@ Sleep 3s
|
||||||
Type "viv info 841"
|
Type "viv info 841"
|
||||||
Enter
|
Enter
|
||||||
Sleep 3s
|
Sleep 3s
|
||||||
Type "python examples/cli.py hello 'prospective viv user!'"
|
Type "python ../examples/cli.py hello 'prospective viv user!'"
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
Type "python examples/cli.py goodbye 'prospective viv user!'"
|
Type "python ../examples/cli.py goodbye 'prospective viv user!'"
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
Set Height 750
|
Set Height 750
|
||||||
Set Width 1500
|
Set Width 1500
|
||||||
Set Theme "Catppuccin Mocha"
|
Set Theme "Catppuccin Mocha"
|
||||||
Output ./docs/freeze.gif
|
Output ./freeze.gif
|
||||||
|
|
||||||
Type "viv freeze --help"
|
Type "viv freeze --help"
|
||||||
Enter
|
Enter
|
||||||
|
|
30
docs/list-info-rm.tape
Normal file
30
docs/list-info-rm.tape
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
Set Height 750
|
||||||
|
Set Width 1500
|
||||||
|
Set Theme "Catppuccin Mocha"
|
||||||
|
Output ./list-info-rm.gif
|
||||||
|
|
||||||
|
Type "cat demo.py"
|
||||||
|
Enter
|
||||||
|
Sleep 500ms
|
||||||
|
Type "python demo.py"
|
||||||
|
Enter
|
||||||
|
Sleep 3s
|
||||||
|
Type "viv list -h"
|
||||||
|
Enter
|
||||||
|
Sleep 500ms
|
||||||
|
Type "viv list -q"
|
||||||
|
Enter
|
||||||
|
Sleep 1s
|
||||||
|
Type "viv info -h"
|
||||||
|
Enter
|
||||||
|
Sleep 500ms
|
||||||
|
Type "viv info "
|
||||||
|
Sleep 1s
|
||||||
|
Type "f8"
|
||||||
|
Enter
|
||||||
|
Sleep 1s
|
||||||
|
Type "viv remove -h"
|
||||||
|
Enter
|
||||||
|
Type "viv rm f8"
|
||||||
|
Enter
|
||||||
|
Sleep 2s
|
Loading…
Reference in a new issue