From c92b956472d6a2b6ac8c4e4873b71eff989590b8 Mon Sep 17 00:00:00 2001 From: Ethanell Date: Mon, 9 Mar 2020 17:59:20 +0100 Subject: [PATCH] Create README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..de7b192 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Kitty Parrots +A fish scrip to show you parrots in kitty + +You need [fish](https://fishshell.com), [kitty](https://sw.kovidgoyal.net/kitty/) and [terminal-parrot](https://github.com/jmhobbs/terminal-parrot) in you patch + +## How to use +* `parrots.fish -h`: show a geart HALP ! +* `parrots.fish -b`: launch parrots in background +* `parrots.fish -d`: stop parrots in background +* `parrots.fish -c`: launch parrots in current kitty terminal (need allow remote control) +* `parrots.fish -s`: set a time to live of parrots +* `parrots.fish -l`: use parrots to lock your computer ! (need xtrlock) +* `parrots.fish -i`: instant spawn of parrots +* `parrots.fish -n`: set number of parrots to display +* `parrots.fish -d`: to active debug mode (verbose)