Add readme

README.md

@@ -0,0 +1,30 @@
+# wipe
+Wipe the content of your terminal with a random animation.
+
+This is a fancy alternative to the `clear` command.
+It plays randomly generated beautiful animations.
+
+### Build & install
+Building this project requires Rust and Cargo to be installed.
+```shell
+cargo build --release
+```
+```shell
+cp ./target/release/wipe /usr/local/bin
+```
+
+### ZSH
+There is a [zsh script](misc/wipe.zsh) which can be 
+sourced to replace `clear` and `CTRL+L` with this program.
+
+### Arch Linux
+There is an [AUR package](https://aur.archlinux.org/packages/wipe-term) called `wipe-term`.
+The zsh script can be sourced like this:
+```shell
+source /usr/share/zsh/plugins/wipe/wipe.zsh
+```
+
+## Showcase
+[![Animation 1](misc/rec-1.gif)]()
+[![Animation 2](misc/rec-2.gif)]()
+[![Animation 3](misc/rec-3.gif)]()

misc/placeholder.txt

@@ -0,0 +1,23 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Sapien faucibus et molestie ac.
+Arcu odio ut sem nulla pharetra. Varius vel pharetra vel turpis nunc eget lorem
+dolor. Vitae elementum curabitur vitae nunc sed velit dignissim sodales. Felis
+donec et odio pellentesque diam volutpat commodo sed egestas. Nam at lectus
+urna duis convallis. Ac turpis egestas sed tempus urna et. Diam quis enim
+lobortis scelerisque fermentum dui faucibus. Et egestas quis ipsum suspendisse
+ultrices gravida. Nec dui nunc mattis enim ut. Fermentum posuere urna nec
+tincidunt praesent semper feugiat nibh sed.
+
+Aliquet enim tortor at auctor urna nunc. Vulputate enim nulla aliquet porttitor
+lacus luctus accumsan tortor. Est velit egestas dui id ornare arcu. Luctus
+accumsan tortor posuere ac ut. At in tellus integer feugiat scelerisque varius
+morbi enim. Et netus et malesuada fames ac turpis egestas. Aliquet nec
+ullamcorper sit amet risus nullam eget. Sit amet facilisis magna etiam tempor
+orci eu. Amet cursus sit amet dictum sit amet justo. Nec ullamcorper sit amet
+risus nullam eget. Justo eget magna fermentum iaculis. Libero justo laoreet sit
+amet cursus. Egestas maecenas pharetra convallis posuere. Quis hendrerit dolor
+magna eget est. Cursus eget nunc scelerisque viverra mauris in aliquam sem
+fringilla. Amet est placerat in egestas erat imperdiet sed euismod nisi. In
+aliquam sem fringilla ut morbi tincidunt augue interdum. Mollis aliquam ut
+porttitor leo. Venenatis urna cursus eget nunc scelerisque viverra mauris in.
+Egestas quis ipsum suspendisse ultrices gravida dictum fusce ut.

misc/script-1.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+cat placeholder.txt
+sleep 1
+wipe \
+  --char-pattern circle \
+  --char-invert false \
+  --char-segments 3 \
+  --char-slices 2 \
+  --char-swap false \
+  --color-pattern wheel \
+  --color-slices 2 \
+  --color-invert false \
+  --color-shift true \
+  --color-swap false \
+  --colors rainbow

misc/script-2.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+cat placeholder.txt
+sleep 1
+wipe \
+  --char-pattern wheel \
+  --char-invert false \
+  --char-segments 2 \
+  --char-slices 2 \
+  --char-swap false \
+  --color-pattern circle \
+  --color-slices 4 \
+  --color-invert false \
+  --color-shift false \
+  --color-swap false \
+  --colors dark-magenta

misc/script-3.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+cat placeholder.txt
+sleep 1
+wipe \
+  --char-pattern rhombus \
+  --char-invert true \
+  --char-segments 2 \
+  --char-slices 2 \
+  --char-swap false \
+  --color-pattern wheel \
+  --color-slices 2 \
+  --color-invert true \
+  --color-shift true \
+  --color-swap false \
+  --colors cyan

misc/wipe.zsh

@@ -0,0 +1,8 @@
+alias clear='wipe'
+
+_wipe() {
+  wipe
+  zle reset-prompt
+}
+zle -N _wipe
+bindkey '^l' _wipe