Merge branch 'master' of https://github.com/klamonte/jexer

[nikiroo-utils.git] / README.md

diff --git a/README.md b/README.md
index d014852d18b2a6139ce463347badd152ea10a875..afb1ca65d4ff7d8cacc54c9bd04dd5e0f24e46cf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ wishing to use the actual C++ Turbo Vision library, see [Sergio
 Sigala's updated version](http://tvision.sourceforge.net/) that runs
 on many more platforms.
 
 Sigala's updated version](http://tvision.sourceforge.net/) that runs
 on many more platforms.
 

-Two backends are available:
+Three backends are available:

 
 * System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal
   (tested on Linux + xterm).  I/O is handled through terminal escape
 
 * System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal
   (tested on Linux + xterm).  I/O is handled through terminal escape


@@ -20,13 +20,29 @@ Two backends are available:
   are supported.  For the demo application, this is the default
   backend on non-Windows platforms.
 
   are supported.  For the demo application, this is the default
   backend on non-Windows platforms.
 

+* The same command-line ECMA-48 / ANSI X3.64 type terminal as above,
+  but to any general InputStream/OutputStream.  See the file
+  jexer.demos.Demo2 for an example of running the demo over a TCP
+  socket.
+

 * Java Swing UI.  This backend can be selected by setting
   jexer.Swing=true.  The default window size for Swing is 132x40,
   which is set in jexer.session.SwingSession.  For the demo
   application, this is the default backend on Windows platforms.
 
 * Java Swing UI.  This backend can be selected by setting
   jexer.Swing=true.  The default window size for Swing is 132x40,
   which is set in jexer.session.SwingSession.  For the demo
   application, this is the default backend on Windows platforms.
 

-The demo application showing the existing UI controls is available via
-'java -jar jexer.jar' or 'java -Djexer.Swing=true -jar jexer.jar' .
+The demo application showing the existing UI controls can be seen in
+three ways:
+
+  * 'java -jar jexer.jar' .  This will use System.in/out on
+    non-Windows, or Swing on Windows.
+
+  * 'java -Djexer.Swing=true -jar jexer.jar' .  This will always use
+    Swing.
+
+  * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a
+    number to run the TCP daemon on).  This will use the telnet
+    protocol to establish an 8-bit clean channel and be aware of
+    screen size changes.

 
 Additional backends can be created by subclassing
 jexer.backend.Backend and passing it into the TApplication
 
 Additional backends can be created by subclassing
 jexer.backend.Backend and passing it into the TApplication


@@ -82,7 +98,7 @@ public class MyApplication extends TApplication {
 }
 ```
 
 }
 ```
 

-See the file demos/Demo1.java for detailed examples.
+See the files in jexer.demos for more detailed examples.

 
 
 
 
 
 


@@ -127,8 +143,9 @@ ambiguous.  This section describes such issues.
     ioctl(TIOCGWINSZ) but without requiring a native library.
 
   - jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of
     ioctl(TIOCGWINSZ) but without requiring a native library.
 
   - jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of

-    cfmakeraw().  The terminal is (blindly!) put back in 'stty sane
-    cooked' mode when exiting.
+    cfmakeraw() when using System.in/out.  System.out is also
+    (blindly!)  put in 'stty sane cooked' mode when exiting.
+

 
 
 System Properties
 
 
 System Properties


@@ -156,18 +173,8 @@ Roadmap
 
 Many tasks remain before calling this version 1.0:
 
 
 Many tasks remain before calling this version 1.0:
 

-0.0.2: STABILIZE EXISTING
-
-- ECMA48Backend running on socket
-

 0.0.3: FINISH PORTING
 
 0.0.3: FINISH PORTING
 

-- TTreeView
-  - Also add keyboard navigation
-- TDirectoryList
-  - Also add keyboard navigation
-- TFileOpen
-

 0.0.4: NEW STUFF
 
 - Making TMenu keyboard accelerators active/inactive
 0.0.4: NEW STUFF
 
 - Making TMenu keyboard accelerators active/inactive


@@ -178,7 +185,6 @@ Many tasks remain before calling this version 1.0:
 
 0.0.5: BUG HUNT
 
 
 0.0.5: BUG HUNT
 

-- TSubMenu keyboard mnemonic not working

 - Swing performance.  Even with double buffering it isn't great.
 
 0.1.0: BETA RELEASE
 - Swing performance.  Even with double buffering it isn't great.
 
 0.1.0: BETA RELEASE