Add README.md

This commit is contained in:
Nicolas 2022-04-10 08:56:57 +02:00
parent cd8c6051e5
commit f29c2a491e
4 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Wipe
Wipe your terminal with a smooth animation.
This is the perfect program for you, if you like `clear` but want to add an unnecessary animation.
## Configuration
All configuration is done using command line parameters.
If you want a persistent solution, you can add an alias to your `.bashrc` equivalent.
TODO
## Showcase
[![Circle](doc/circle.gif)]()
[![Rhombus](doc/rhombus.gif)]()
[![Rotation](doc/rotation.gif)]()

BIN
doc/circle.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 275 KiB

BIN
doc/rhombus.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 KiB

BIN
doc/rotation.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 223 KiB