diff --git a/README.md b/README.md index 59394b8..15880a6 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,19 @@ ## Tiny coloured fetch script with cute little animals +> [!NOTE] > This script works on both Linux and Mac OS systems. Enjoy~ :3 -A "fork" of [elenapan](https://github.com/elenapan)'s [bunnyfetch](https://github.com/elenapan/dotfiles/blob/master/bin/bunnyfetch) script. -Uses improvements from [strafe/bunnyfetch](https://github.com/strafe/bunnyfetch/) and adds Mac OS compatibility +A fork of [elenapan](https://github.com/elenapan)'s [bunnyfetch](https://github.com/elenapan/dotfiles/blob/feb0452d5ed2ab1a49aada4c9c46cf3f78c18094/bin/bunnyfetch) script. +Uses improvements from [strafe/bunnyfetch](https://github.com/strafe/bunnyfetch/blob/0283d355928df7aafd1d92607a3e452417246fd0/bunnyfetch) and adds Mac OS compatibility. image ### Install - Place the fetch script somewhere on your `$PATH` (I use `$HOME/.local/bin/`) -- Make it executable by running `chmod a+x ./cutefetch` in the directory it is located -- It is recommended to use a [NerdFont](https://www.nerdfonts.com/) as your terminal font if the glyphs are not being displayed properly. +- Make it executable by running `chmod +x ./cutefetch` in the directory it is located +- Use a [NerdFont](https://www.nerdfonts.com/) with your terminal to display glyphs properly ### Usage @@ -21,33 +22,26 @@ After installation, run `cutefetch` in the terminal. Command line arguments can be passed to specify the animal and eye style. -- Valid animal arguments: --kitty, -k, --bunny, -b -- Valid eye styles: integers from 0 to 13 - -Examples: `cutefetch --kitty 6`, `cutefetch -k 6`, `cutefetch` prints the default kitty. -`cutefetch --bunny 0`, `cutefetch -b 0`, `cutefetch -b`, etc. prints a bunny. - -#### Output of `cutefetch --help` +#### Output of `cutefetch -h` ``` Cutefetch - Tiny coloured fetch script to display sysinfo -USAGE: cutefetch [MODE] [EYE_SELECTOR] +USAGE: cutefetch [-m MODE] [-e EYES] [-r] [-v] [-h] [MODE]: - -h, --help: print this help message - -k, --kitty: show kitty ascii art with sysinfo - -k2, --kitty2: show kitty ascii art with sysinfo (2nd variant) - -b, --bunny: show bunny ascii art with sysinfo - -p, --puppy: show puppy ascii art with sysinfo - -s, --simple: show sysinfo with no ascii art - -v, --version: print the version number - no option: same as -k, --kitty - unkown option: print this help message - and return status code 1 - - [EYE_SELECTOR] (optional): - (numbers from 0 to 14) + cat, kitty : show kitty ascii art with sysinfo + catfull, cat2, kitty2 : show kitty ascii art with sysinfo (full body) + bunny, rabbit : show bunny ascii art with sysinfo + dog, doggo, doggy : show doggy ascii art with sysinfo + penguin, pengu, pingu : show penguin ascii art with sysinfo + minimal, simple : show sysinfo with no ascii art + none, noglyph, text : show sysinfo with text only + + [EYES]: + Numbers from 0 to 15: + Selects eyes for cats, bunny, and dog + 0: . . 1: · · 2: ^ ^ @@ -63,22 +57,28 @@ USAGE: cutefetch [MODE] [EYE_SELECTOR] 12: o o 13: o.o 14: ° o + no/other number: ^.^ (kitty) or . . (bunny) - or 0 0 (puppy) + or · · (doggy) + + [-r] : use randomized ascii art + [-v] : print the version number + [-h] : print this help message + [no option] : same as: cutefetch -m cat -e 6 + [unkown option] : print this help message + and return status code 1 ``` -### Extras - -`cutefetch $(printf '-k\n-b\n-p' | shuf -n 1) $(shuf -i 1-13 -n 1)` prints a random animal with random face. Add this to your `.zshrc`, `.bashrc`, `config.fish`, etc. to spice up your shell. :3 - -_this wonderful idea of randomizing the animal and face was contributed by [Westofer](https://github.com/westofer)_ - ### Screenshots ![desktop](https://imgur.com/tX8Fqt4.png) +### Credits +- Randomization of ascii art suggested by [Westofer](https://github.com/westofer) +- Thanks to our [contributors](https://github.com/cybardev/cutefetch/graphs/contributors) for code and ideas + ### Links: - [original script](https://github.com/elenapan/dotfiles/blob/master/bin/bunnyfetch)