experimental 24-bit image protocol

[nikiroo-utils.git] / README.md

diff --git a/README.md b/README.md
index 7e21e980d20f6f99a1aa6b1548ebc2ab8a0a11fa..4e6127abaf1582a7d8d337720bd7e5664f35234b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ reminiscent of Borland's [Turbo
 Vision](http://en.wikipedia.org/wiki/Turbo_Vision) system.  It looks
 like this:
 
-![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal")
+![Terminal, Image, Table](/screenshots/new_demo1.png?raw=true "Terminal, Image, Table")
 
 Jexer works on both Xterm-like terminals and Swing, and supports
 images in both Xterm and Swing.  On Swing, images are true color:
@@ -36,7 +36,7 @@ Jexer is available on Maven Central:
 <dependency>
   <groupId>com.gitlab.klamonte</groupId>
   <artifactId>jexer</artifactId>
-  <version>0.3.1</version>
+  <version>0.3.2</version>
 </dependency>
 ```
 
@@ -54,6 +54,8 @@ Documentation
 
 * [Wiki](https://gitlab.com/klamonte/jexer/wikis/home)
 
+* [Jexer web page](https://jexer.sourceforge.io/)
+
 
 
 Programming Examples
@@ -65,6 +67,10 @@ The examples/ folder currently contains:
     manager](/examples/JexerTilingWindowManager.java) in less than 250
     lines of code.
 
+  * A much slicker [prototype tiling window
+    manager](/examples/JexerTilingWindowManager2.java) in less than 200
+    lines of code.
+
   * A [prototype image thumbnail
     viewer](/examples/JexerImageViewer.java) in less than 350 lines of
     code.
@@ -98,15 +104,27 @@ controls.  The demos can be run as follows:
     applications performing I/O across three screens: an Xterm screen
     and Swing screen, monitored from a third Swing screen.
 
+  * 'java -cp jexer.jar jexer.demos.Demo7' .  This demonstrates the
+    BoxLayoutManager, achieving a similar result as the
+    javax.swing.BoxLayout apidocs example.
+
 
 
 More Screenshots
 ----------------
 
+Jexer can be run inside its own terminal window, with support for all
+of its features including images and mouse, and more terminals:
+
 ![Yo Dawg...](/screenshots/jexer_sixel_in_sixel.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.")
 
+Sixel output uses a single palette which works OK for a variety of
+real-world images:
+
 ![Sixel Pictures Of Cliffs Of Moher And Buoy](/screenshots/sixel_images.png?raw=true "Sixel Pictures Of Cliffs Of Moher And Buoy")
 
+The color wheel with that palette is shown below:
+
 ![Sixel Color Wheel](/screenshots/sixel_color_wheel.png?raw=true "Sixel Color Wheel")
 
 
@@ -119,16 +137,21 @@ The table below lists terminals tested against Jexer's Xterm backend:
 | Terminal       | Environment        | Mouse Click | Mouse Cursor | Images |
 | -------------- | ------------------ | ----------- | ------------ | ------ |
 | xterm          | X11                | yes         | yes          | yes    |
-| jexer(3)       | CLI, X11, Windows  | yes         | yes          | yes    |
+| jexer          | CLI, X11, Windows  | yes         | yes          | yes    |
 | mlterm         | X11                | yes         | yes          | yes    |
-| lcxterm(3)     | CLI, Linux console | yes         | yes          | no     |
-| rxvt-unicode   | X11                | yes         | yes          | no(2)  |
+| RLogin         | Windows            | yes         | yes          | yes    |
 | alacritty(3)   | X11                | yes         | yes          | no     |
 | gnome-terminal | X11                | yes         | yes          | no     |
+| iTerm2         | Mac                | yes         | yes          | no(5)  |
+| kitty(3)       | X11                | yes         | yes          | no     |
+| lcxterm(3)     | CLI, Linux console | yes         | yes          | no     |
+| mintty         | Windows            | yes         | yes          | no(5)  |
+| rxvt-unicode   | X11                | yes         | yes          | no(2)  |
 | xfce4-terminal | X11                | yes         | yes          | no     |
 | aminal(3)      | X11                | yes         | no           | no     |
 | konsole        | X11                | yes         | no           | no     |
 | yakuake        | X11                | yes         | no           | no     |
+| Windows Terminal(6) | Windows       | no          | no           | no(2)  |
 | screen         | CLI                | yes(1)      | yes(1)       | no(2)  |
 | tmux           | CLI                | yes(1)      | yes(1)       | no     |
 | putty          | X11, Windows       | yes         | no           | no(2)  |
@@ -145,6 +168,11 @@ The table below lists terminals tested against Jexer's Xterm backend:
 
 4 - Requires TERM=xterm-1003 before starting.
 
+5 - Sixel images can crash terminal.
+
+6 - Version 0.4.2382.0, on Windows 10.0.18362.30.  Tested against
+    WSL-1 Debian instance.
+
 
 
 See Also