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

24 lines
570 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)
2020-06-11 14:41:32 +00:00
To use it, add `catimg` to the plugins array in your zshrc file:
2019-01-12 15:47:23 +00:00
2020-06-11 14:41:32 +00:00
```zsh
plugins=(... catimg)
```
2019-01-12 15:47:23 +00:00
2020-06-11 14:41:32 +00:00
## Requirements
2019-01-12 15:47:23 +00:00
2020-06-11 14:41:32 +00:00
- `convert` (ImageMagick)
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)