diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-10-24 17:57:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-24 17:57:01 +0200 |
| commit | cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch) | |
| tree | 2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/catimg/README.md | |
| parent | 225425fe091ca052997833279ccc08643818c24a (diff) | |
| parent | 40df67bc3b9b51caa24df5d220487043040d1f9a (diff) | |
| download | zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2 zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip | |
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/catimg/README.md')
| -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) |