conf2/zsh/.oh-my-zsh/plugins/catimg/README.md

36 lines
745 B
Markdown
Raw Normal View History

2019-01-12 15:47:23 +00:00
# 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
)
```
2019-11-22 19:01:23 +00:00
2. Restart the shell or restart your Terminal session:
2019-01-12 15:47:23 +00:00
```console
2019-11-22 19:01:23 +00:00
$ exec zsh
2019-01-12 15:47:23 +00:00
$
```
## 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)