daylin/viv
1
0
Fork 0
mirror of https://github.com/daylinmorgan/viv.git synced 2024-11-12 12:13:15 -06:00
Code Issues Projects Releases Packages Wiki Activity

docs: start generating usage documentation in the form of VHS tapes

Browse source
This commit is contained in:
Daylin Morgan 2022-12-26 17:24:12 -06:00
parent e96e4ab18c
commit 2995cf56db
3 changed files with 33 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Makefile
View file

@ -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

20
docs/freeze.tape Normal file
View file

@ -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

11
docs/usage.md Normal file
View file

@ -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
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/docs/demo.gif" alt="demo" width=600 >
# Freeze
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/docs/freeze.gif" alt="demo" width=600 >