docs: add demo.gif

This commit is contained in:
Daylin Morgan 2022-12-20 14:29:21 -06:00
parent e7090955e0
commit bde564f381
4 changed files with 44 additions and 3 deletions

View file

@ -20,4 +20,9 @@ install:
uninstall: uninstall:
rm ~/bin/viv rm ~/bin/viv
.PHONY: env lint install uninstall bump-version types docs: docs/demo.gif
docs/%.gif: docs/%.tape
vhs < $<
.PHONY: env lint install uninstall bump-version types docs

View file

@ -1,4 +1,15 @@
# Viv isn't venv # Viv
<!-- PROJECT DEMO -->
<div align="center">
<a href="https://github.com/daylinmorgan/viv">
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/docs/demo.gif" alt="Logo" width=600 >
</a>
<p align="center">
viv isn't venv
</p>
</div>
<br />
## Setup ## Setup
@ -32,7 +43,8 @@ viv remove $(viv list -q)
## TODO ## TODO
- [ ] add doc strings to `src/viv.py`
- [ ] add doc strings to `src/viv/viv.py`
- [ ] use config file (probably ini or json / could also allow toml for python>=3.11) - [ ] use config file (probably ini or json / could also allow toml for python>=3.11)
- [ ] enable a garbage collection based on time or file existence (configurable) - [ ] enable a garbage collection based on time or file existence (configurable)
- [ ] unit tests - [ ] unit tests

BIN
docs/demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 757 KiB

24
docs/demo.tape Normal file
View file

@ -0,0 +1,24 @@
Set Height 750
Set Width 1500
Set Theme "Catppuccin Mocha"
Output ./docs/demo.gif
Type "viv list"
Enter
Sleep 2s
Type "python examples/cli.py --help"
Enter
Sleep 10s
Type "viv list"
Enter
Sleep 3s
Type "viv info 841"
Enter
Sleep 3s
Type "python examples/cli.py hello 'prospective viv user!'"
Enter
Sleep 2s
Type "python examples/cli.py goodbye 'prospective viv user!'"
Enter
Sleep 2s