Skip to content

Commit f135370

Browse files
committed
Update documents
1 parent 40a86da commit f135370

2 files changed

Lines changed: 13 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,14 +116,18 @@ These image protocols are supported:
116116

117117
- [Inline Images Protocol (iTerm2)](https://iterm2.com/documentation-images.html)
118118
- [Terminal graphics protocol (kitty)](https://sw.kovidgoyal.net/kitty/graphics-protocol/)
119-
- Supports both the existing graphics protocol mode and [the Unicode placeholder](https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders) mode.
119+
- Supports both the existing graphics protocol mode and the [Unicode placeholder](https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders) mode.
120120

121121
For more information, see [Compatibility](https://lusingander.github.io/serie/getting-started/compatibility.html).
122122

123+
### Partially supported environments
124+
125+
- tmux is supported only when using the kitty Unicode placeholder protocol.
126+
123127
### Unsupported environments
124128

125129
- Sixel graphics is not supported.
126-
- Terminal multiplexers (screen, tmux, Zellij, etc.) are not supported.
130+
- Other terminal multiplexers (screen, Zellij, etc.) other than those listed in [Partially supported environments](#partially-supported-environments) are not supported.
127131
- Windows is not officially supported. Please refer to [the related issue](https://github.com/lusingander/serie/issues/147#issuecomment-4192875627).
128132

129133
## Screenshots

docs/src/getting-started/compatibility.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,13 @@ The terminals on which each has been confirmed to work are listed below.
3030

3131
Rendering using Unicode Placeholder is available by explicitly specifying `kitty-unicode` as `protocol` option or config.
3232

33-
## Unsupported environments
33+
### Partially supported environments
34+
35+
- tmux is supported only when using the kitty Unicode placeholder protocol.
36+
- Requires `set -g allow-passthrough on` in tmux.conf (version 3.2+).
37+
38+
### Unsupported environments
3439

3540
- Sixel graphics is not supported.
36-
- Terminal multiplexers (screen, tmux, Zellij, etc.) are not supported.
41+
- Other terminal multiplexers (screen, Zellij, etc.) other than those listed in [Partially supported environments](#partially-supported-environments) are not supported.
3742
- Windows is not officially supported. Please refer to [the related issue](https://github.com/lusingander/serie/issues/147#issuecomment-4192875627).

0 commit comments

Comments
 (0)