diff options
| author | Luiz Guilherme Fonseca Rosa <luizguilhermefr@gmail.com> | 2018-10-08 10:20:10 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-08 10:20:10 -0300 |
| commit | ed401bc55af2e5b08d1ff903111a65838473ad9d (patch) | |
| tree | 621f7623dedf79dd9117a20e84c0997eac8217e3 /plugins/catimg | |
| parent | c2113d7cc67e2865a4692918198fba27e8360fe5 (diff) | |
| parent | 7b29684a3087c881f240ebb74bd387c69f0ffcc6 (diff) | |
| download | zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.gz zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.bz2 zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.zip | |
Merge branch 'master' into master
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) |