From 114088b845895d66611c844fc7b9928030acb8e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9D=8E=E9=80=9A=E6=B4=B2?= <zhangsongcui3371@sina.com>
Date: Sat, 12 Apr 2025 20:33:18 +0800
Subject: [PATCH] Doc: add comments about displaying image logo on Windows [ci
 skip]

Fix  #1686
---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/README.md b/README.md
index 7e9643cb4..683679640 100644
--- a/README.md
+++ b/README.md
@@ -230,6 +230,56 @@ Set the key to a white space.
 }
 ```
 
+### Q: How can I display images on Windows?
+
+As of April 2025:
+
+#### mintty and Wezterm
+
+mintty (used by Bash on Windows and MSYS2) and Wezterm (nightly build only) support the iTerm image protocol on Windows.
+
+In `config.jsonc`:  
+```json
+{
+  "logo": {
+    "type": "iterm",
+    "source": "C:/path/to/image.png",
+    "width": <num-in-chars>
+  }
+}
+```
+
+#### Windows Terminal
+
+Windows Terminal supports the sixel image protocol only.
+
+* If you installed fastfetch through MSYS2:
+    1. Install imagemagick: `pacman -S mingw-w64-<subsystem>-x86_64-imagemagick`
+    2. In `config.jsonc`:  
+```jsonc
+{
+  "logo": {
+    "type": "sixel", // DO NOT USE "auto"
+    "source": "C:/path/to/image.png", // Do NOT use `~` as fastfetch is a native Windows program and doesn't apply cygwin path conversion
+    "width": <image-width-in-chars>, // Optional
+    "height": <image-height-in-chars> // Optional
+  }
+}
+```
+* If you installed fastfetch via scoop or downloaded the binary directly from the GitHub Releases page:
+    1. Convert your image manually to sixel format using [any online image conversion service](https://www.google.com/search?q=convert+image+to+sixel)
+    2. In `config.jsonc`:  
+```jsonc
+{
+  "logo": {
+    "type": "raw", // DO NOT USE "auto"
+    "source": "C:/path/to/image.sixel",
+    "width": <image-width-in-chars>, // Required
+    "height": <image-height-in-chars> // Required
+  }
+}
+```
+
 ### Q: I want feature A / B / C. Will fastfetch support it?
 
 Fastfetch is a system information tool. We only accept hardware or system-level software feature requests. For most personal uses, I recommend using the `Command` module to implement custom functionality, which can be used to grab output from a custom shell script: