mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-19 21:41:07 +01:00
catimg: add README (#7232)
This commit is contained in:
parent
50cb0846a9
commit
43e5c9093a
1 changed files with 35 additions and 0 deletions
35
plugins/catimg/README.md
Normal file
35
plugins/catimg/README.md
Normal file
|
@ -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)
|
Loading…
Reference in a new issue