Create README.md

This commit is contained in:
Ethanell 2020-03-09 17:59:20 +01:00 committed by GitHub
parent 1deef7ef0e
commit c92b956472
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

15
README.md Normal file
View file

@ -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)