diff --git a/README.md b/README.md index dc19362..b9fd9fc 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,30 @@ cargo build --release 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. +### Shell Integration +There are scripts for different shells which can be sourced to replace `clear` and `CTRL+L` with this program. +The scripts are located in `misc/shell/`. + +| Shell | Script | +|:------|:-------------| +| ZSH | `wipe.zsh` | +| Fish | `wipe.fish` | ### 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: +The scripts can be integrated as follows: + +#### ZSH +Put this into your `.zshrc`: ```shell source /usr/share/zsh/plugins/wipe/wipe.zsh ``` +#### Fish +The package will place the script under `/usr/share/fish/vendor_conf.d/` +which will be sourced by `fish` with no further configuration required. + ## Showcase -[![Animation 1](misc/rec-1.gif)]() -[![Animation 2](misc/rec-2.gif)]() -[![Animation 3](misc/rec-3.gif)]() \ No newline at end of file +[![Animation 1](misc/res/rec-1.gif)]() +[![Animation 2](misc/res/rec-2.gif)]() +[![Animation 3](misc/res/rec-3.gif)]() \ No newline at end of file diff --git a/misc/placeholder.txt b/misc/res/placeholder.txt similarity index 100% rename from misc/placeholder.txt rename to misc/res/placeholder.txt diff --git a/misc/rec-1.gif b/misc/res/rec-1.gif similarity index 100% rename from misc/rec-1.gif rename to misc/res/rec-1.gif diff --git a/misc/rec-2.gif b/misc/res/rec-2.gif similarity index 100% rename from misc/rec-2.gif rename to misc/res/rec-2.gif diff --git a/misc/rec-3.gif b/misc/res/rec-3.gif similarity index 100% rename from misc/rec-3.gif rename to misc/res/rec-3.gif diff --git a/misc/script-1.sh b/misc/res/script-1.sh similarity index 100% rename from misc/script-1.sh rename to misc/res/script-1.sh diff --git a/misc/script-2.sh b/misc/res/script-2.sh similarity index 100% rename from misc/script-2.sh rename to misc/res/script-2.sh diff --git a/misc/script-3.sh b/misc/res/script-3.sh similarity index 100% rename from misc/script-3.sh rename to misc/res/script-3.sh diff --git a/misc/shell/wipe.fish b/misc/shell/wipe.fish new file mode 100644 index 0000000..3f1ad93 --- /dev/null +++ b/misc/shell/wipe.fish @@ -0,0 +1,7 @@ +#!/usr/bin/env fish + +function clear + command wipe +end + +bind \cl 'wipe; commandline -f repaint' \ No newline at end of file diff --git a/misc/wipe.zsh b/misc/shell/wipe.zsh similarity index 100% rename from misc/wipe.zsh rename to misc/shell/wipe.zsh