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
|
|
|
## 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
|
|
|
|
2020-06-11 14:59:30 +00:00
|
|
|
## Enabling the plugin
|
|
|
|
|
|
|
|
|
|
1. Open your `.zshrc` file and add `catimg` in the plugins section:
|
|
|
|
|
|
|
|
|
|
```zsh
|
|
|
|
|
plugins=(
|
|
|
|
|
# all your enabled plugins
|
|
|
|
|
catimg
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Restart the shell or restart your Terminal session:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ exec zsh
|
|
|
|
|
$
|
|
|
|
|
```
|
|
|
|
|
|
2019-01-12 15:47:23 +00:00
|
|
|
## Functions
|
|
|
|
|
|
|
|
|
|
| Function | Description |
|
|
|
|
|
| -------- | ---------------------------------------- |
|
|
|
|
|
| `catimg` | Displays the given image on the terminal |
|
|
|
|
|
|
|
|
|
|
## Usage examples
|
|
|
|
|
|
|
|
|
|
[](https://asciinema.org/a/204702)
|
