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": + } +} +``` + +#### Windows Terminal + +Windows Terminal supports the sixel image protocol only. + +* If you installed fastfetch through MSYS2: + 1. Install imagemagick: `pacman -S mingw-w64--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": , // Optional + "height": // 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": , // Required + "height": // 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: