From 3ecc3a8273dbe30e2d1a784c913be1224211b8c4 Mon Sep 17 00:00:00 2001
From: Igor Chubin <igor@chub.in>
Date: Thu, 29 Oct 2020 20:34:44 +0100
Subject: [PATCH] Add doc/

---
 doc/terminal-images.md | 59 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 doc/terminal-images.md

diff --git a/doc/terminal-images.md b/doc/terminal-images.md
new file mode 100644
index 0000000..66944f9
--- /dev/null
+++ b/doc/terminal-images.md
@@ -0,0 +1,59 @@
+
+## Map view (v3)
+
+In the experimental map view, that is available under the view code `v3`,
+weather information about a geographical region is available:
+
+```
+    $ curl v3.wttr.in/Bayern.sxl
+```
+
+![v3.wttr.in/Bayern](https://v3.wttr.in/Bayern.png)
+
+or directly in browser:
+
+*   https://v3.wttr.in/Bayern
+
+The map view currently supports three formats:
+
+* PNG (for browser and messangers);
+* Sixel (terminal inline images support);
+* IIP (terminal with iterm2 inline images protocol support).
+
+## Terminal with images support
+
+
+| Terminal              | Environment    | Images support | Protocol |
+| --------------------- | --------- | ------------- | --------- |
+| uxterm                |   X11     |   yes         |   Sixel   |
+| mlterm                |   X11     |   yes         |   Sixel   |
+| kitty                 |   X11     |   yes         |   Kitty   |
+| wezterm               |   X11     |   yes         |   IIP     |
+| aminal                |   X11     |   yes         |   Sixel   |
+| Jexer                 |   X11     |   yes         |   Sixel   |
+| GNOME Terminal        |   X11     |   [in-progress](https://gitlab.gnome.org/GNOME/vte/-/issues/253) |   Sixel   |
+| alacritty             |   X11     |   [in-progress](https://github.com/alacritty/alacritty/issues/910) |  Sixel   |
+| DomTerm               |   Web     |   yes         |   Sixel   |
+| Yaft                  |   FB      |   yes         |   Sixel   |
+| iTerm2                |   Mac OS X|   yes         |   IIP     |
+| mintty                | Windows   |   yes         |   Sixel   |
+| Windows Terminal  |   Windows     |   [in-progress](https://github.com/microsoft/terminal/issues/448) |   Sixel   |
+| [RLogin](http://nanno.dip.jp/softlib/man/rlogin/) | Windows | yes         |   Sixel   |   |
+
+## Notes
+
+### xterm/uxterm
+
+To start xterm/uxterm with Sixel support:
+
+```
+uxterm -ti vt340
+```
+
+### Kitty
+
+To view images in kitty:
+
+```
+curl -ks v3.wttr.in/Tabasco.png | kitty icat --align=left
+```