Skip to content

Commit

Permalink
Add note on README re: windows and images
Browse files Browse the repository at this point in the history
  • Loading branch information
mfontanini committed Oct 20, 2023
1 parent e8dbb28 commit 1e51eec
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,16 @@ _presenterm_ with the `sixel` feature flag, which is disabled by default. You ca
cargo build --release --features sixel
```

> **Note**: this feature flag is only needed if your terminal emulator only supports sixel. many terminals support the kitty or iterm2 protocols so this isn't necessary.
> **Note**: this feature flag is only needed if your terminal emulator only supports sixel. Many terminals support the kitty or iterm2 protocols so this isn't necessary.
Images are rendered **in their default size**. This means if your terminal window is 100 pixels wide and your image is
50 pixels wide, it will take up 50% of the width. If an image does not fit in the screen, it will be scaled down to fit
it.

![](assets/demo-image.png)

> **Note**: image rendering is currently not supported on Windows.
## Themes

_presenterm_ supports themes so you can customize your presentation's look. See the [built-in themes](themes) as
Expand Down

0 comments on commit 1e51eec

Please sign in to comment.