diff options
| author | Griko Nibras <grikomsn@gmail.com> | 2018-10-05 14:43:45 +0700 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-05 09:43:45 +0200 |
| commit | 43e5c9093a303acaac861c723b4de1914adcf99f (patch) | |
| tree | b9749e05ddca8e04750bee52e245e8068dab8ad4 /plugins/catimg | |
| parent | 50cb0846a9b8216a17fa1e7161ab6562f1dff593 (diff) | |
| download | zsh-43e5c9093a303acaac861c723b4de1914adcf99f.tar.gz zsh-43e5c9093a303acaac861c723b4de1914adcf99f.tar.bz2 zsh-43e5c9093a303acaac861c723b4de1914adcf99f.zip | |
catimg: add README (#7232)
Diffstat (limited to 'plugins/catimg')
| -rw-r--r-- | plugins/catimg/README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md new file mode 100644 index 000000000..2fc28a1c6 --- /dev/null +++ b/plugins/catimg/README.md @@ -0,0 +1,35 @@ +# catimg + +Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg) + +## Requirements + +- `convert` (ImageMagick) + +## Enabling the plugin + +1. Open your `.zshrc` file and add `catimg` in the plugins section: + + ```zsh + plugins=( + # all your enabled plugins + catimg + ) + ``` + +2. Reload the source file or restart your Terminal session: + + ```console + $ source ~/.zshrc + $ + ``` + +## Functions + +| Function | Description | +| -------- | ---------------------------------------- | +| `catimg` | Displays the given image on the terminal | + +## Usage examples + +[](https://asciinema.org/a/204702) |