From 0c882097f672b8d07c96f95296d904f3d5a81083 Mon Sep 17 00:00:00 2001 From: Nikita Ivanov Date: Sun, 26 Mar 2023 00:41:45 +0100 Subject: [PATCH] Update docs Add requirement for a terminal when using Wayland --- README.md | 2 ++ doc/ctpv.1 | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index 2e61cb4..8c83cc8 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,7 @@ set cleaner ctpvclear If you use Wayland, follow these steps: +* Make sure you use one of the [terminals that support sixel][sixel] * Install [this fork of lf][lf-sixel] * Install [Chafa][chafa] * Add `set chafasixel` to `~/.config/ctpv/config` @@ -135,3 +136,4 @@ configuration and how to define custom previews can be found here: [chafa]: https://github.com/hpjansson/chafa [lf]: https://github.com/gokcehan/lf [lf-sixel]: https://github.com/horriblename/lf +[sixel]: https://www.arewesixelyet.com diff --git a/doc/ctpv.1 b/doc/ctpv.1 index 14740de..c9bd02e 100644 --- a/doc/ctpv.1 +++ b/doc/ctpv.1 @@ -183,6 +183,11 @@ To enable high-resolution image previews on you need to follow these steps: . .IP \(bu 4 +Make sure you use one of the +.UR https://\:www\:.arewesixelyet\:.com +terminals that support sixel +.UE +.IP \(bu 4 Install .UR https://\:github\:.com/\:horriblename/\:lf .I lf-sixel