diff options
author | Tuowen Zhao <ztuowen@gmail.com> | 2018-10-09 14:46:47 -0400 |
---|---|---|
committer | Tuowen Zhao <ztuowen@gmail.com> | 2018-10-09 14:46:47 -0400 |
commit | 075160b86c64045e661209ad7906559068b44104 (patch) | |
tree | a910a6eef6163d39859395bb0b416b2b184db9ac /plugins/catimg | |
parent | 5ece6ef2f07c58672a9c965dbbbb62a42386fb2d (diff) | |
parent | 3c9942c4884089b290ef750468b29419ca0de271 (diff) | |
download | zsh-075160b86c64045e661209ad7906559068b44104.tar.gz zsh-075160b86c64045e661209ad7906559068b44104.tar.bz2 zsh-075160b86c64045e661209ad7906559068b44104.zip |
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/catimg')
-rw-r--r-- | plugins/catimg/README.md | 35 | ||||
-rw-r--r--[-rwxr-xr-x] | plugins/catimg/catimg.sh | 0 |
2 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 + +[![asciicast](https://asciinema.org/a/204702.png)](https://asciinema.org/a/204702) diff --git a/plugins/catimg/catimg.sh b/plugins/catimg/catimg.sh index 83ccf6a95..83ccf6a95 100755..100644 --- a/plugins/catimg/catimg.sh +++ b/plugins/catimg/catimg.sh |