Skip to content

Commit

Permalink
#1341, update wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
o2sh committed May 10, 2024
1 parent ed99fe2 commit df49072
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/wiki/Images-in-the-terminal.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Onefetch supports displaying images using [`kitty`](https://sw.kovidgoyal.net/kitty/graphics-protocol.html), [`Sixel`](https://en.wikipedia.org/wiki/Sixel) and [`iTerm`](https://www.iterm2.com/documentation-images.html).
Onefetch supports displaying images using [`kitty`](https://sw.kovidgoyal.net/kitty/graphics-protocol.html), [`Sixel`](https://en.wikipedia.org/wiki/Sixel) and [`iTerm`](https://www.iterm2.com/documentation-images.html) protocols.

<p align="center">
<img src="https://raw.githubusercontent.com/o2sh/onefetch/main/assets/screenshot-1.png" height="250px">
</p>

When running `onefetch --image ./My-picture.jpg`, the program looks for the first `Image Backend` supported by the terminal and use it to display the requested image instead of the Ascii logo.
When running `onefetch --image ./My-picture.jpg`, the program looks for the first `Image Protocol` supported by the terminal and use it to display the requested image instead of the Ascii logo.

If you decide to go manual, and want to force the use of a specific image backend --> `onefetch --image ./My-picture.jpg --image-backend sixel|kitty|iterm`
If you decide to go manual, and want to force the use of a specific image protocol: `onefetch --image ./My-picture.jpg --image-protocol sixel|kitty|iterm`

### Sixel

Expand All @@ -20,4 +20,4 @@ The kitty terminal graphics protocol used on the terminal of the same name allow

### ITerm

The iTerm inline image protocol supported by iTerm2 (also WezTerm) allows to display images within the terminal.
The iTerm inline image protocol supported by iTerm2 (also WezTerm) allows to display images within the terminal.

0 comments on commit df49072

Please sign in to comment.