Test commit from within Eclipse

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index af877888f665d3cd8af02457bc73cc7b64bd3457..ee5a26543ff6436057ee4784a26be3ef42ec14b4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 Jexer - Java Text User Interface library
 ========================================
 
-WARNING: THIS IS ALPHA CODE!
+WARNING: THIS IS ALPHA CODE!  PLEASE CONSIDER FILING BUGS AS YOU
+ENCOUNTER THEM.
 
 This library is intended to implement a text-based windowing system
 loosely reminiscient of Borland's [Turbo
@@ -16,16 +17,20 @@ Two backends are available:
   (tested on Linux + xterm).  I/O is handled through terminal escape
   sequences generated by the library itself: ncurses is not required
   or linked to.  xterm mouse tracking using UTF8 coordinates is
-  supported.  This is the default backend on non-Windows platforms.
+  supported.  For the demo application, this is the default backend on
+  non-Windows platforms.
 
-* Java AWT UI.  This backend can be selected by setting
-  jexer.AWT=true.  This is the default backend on Windows platforms.
-  AWT is experimental, please consider filing bugs when you encounter
-  them.  The default window size for AWT is 132x40, which is set in
-  jexer.session.AWTSession.
+* 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.
 
-A demo application showing the existing UI controls is available via
-'java -jar jexer.jar' or 'java -Djexer.AWT=true -jar jexer.jar' .
+The demo application showing the existing UI controls is available via
+'java -jar jexer.jar' or 'java -Djexer.Swing=true -jar jexer.jar' .
+
+Additional backends can be created by subclassing
+jexer.backend.Backend and passing it into the TApplication
+constructor.
 
 
 
@@ -55,7 +60,7 @@ Usage
 -----
 
 Usage patterns are still being worked on, but in general the goal will
-be to build applications somewhat as follows:
+be to build applications as follows:
 
 ```Java
 import jexer.*;
@@ -63,7 +68,7 @@ import jexer.*;
 public class MyApplication extends TApplication {
 
     public MyApplication() {
-        super();
+        super(BackendType.SWING); // Could also use BackendType.XTERM
 
         // Create standard menus for File and Window
         addFileMenu();
@@ -72,7 +77,7 @@ public class MyApplication extends TApplication {
 
     public static void main(String [] args) {
         MyApplication app = new MyApplication();
-        app.run();
+        (new Thread(app)).start();
     }
 }
 ```
@@ -100,6 +105,20 @@ ambiguous.  This section describes such issues.
   - See jexer.tterminal.ECMA48 for more specifics of terminal
     emulation limitations.
 
+  - TTerminalWindow uses cmd.exe on Windows.  Output will not be seen
+    until enter is pressed, due to cmd.exe's use of line-oriented
+    input (see the ENABLE_LINE_INPUT flag for GetConsoleMode() and
+    SetConsoleMode()).
+
+  ECMA48 Backend
+  --------------
+  
+  - Mouse support for BackendType.ECMA48/XTERM currently requires UTF-8 
+    coordinates (1005 mode).  Terminals that support UTF-8 mouse coordinates
+    include xterm, rxvt-unicode, gnome-terminal, and konsole.  Due to Java's
+    InputStreamReader requirement of a valid UTF-8 stream, one must assume
+    the terminal will always generate correct UTF-8 bytes.  Mode 1006 (SGR)
+    will be supported in a future release.
 
 
 
@@ -108,15 +127,14 @@ Roadmap
 
 Many tasks remain before calling this version 1.0:
 
-0.0.2:
+0.0.2: STABILIZE EXISTING
 
-- Making TMenu keyboard accelerators active/inactive
-- AWT:
+- TTerminalWindow
+  - Expose shell commands as properties
+- Swing:
   - Blinking cursor
   - Block cursor
 - ECMA48Backend running on socket
-- TTreeView
-- TDirectoryList
 - TFileOpen
 - Decide on naming convention: getText, getValue, getLabel: one or all
   of them?
@@ -125,24 +143,37 @@ Many tasks remain before calling this version 1.0:
     - getCh() --> getChar()
     - getAlt/getCtrl/getShift --> isAltDown / isCtrlDown / isShiftDown
   - Other boolean getters --> isSomething
+- Document any properties used
+  - Expose use of 'stty'
 
-0.0.3:
+0.0.3: FINISH PORTING
 
+- TTreeView
+  - Also add keyboard navigation
+- TDirectoryList
+  - Also add keyboard navigation
+
+0.0.4: NEW STUFF
+
+- Making TMenu keyboard accelerators active/inactive
 - TStatusBar
 - TEditor
+- TWindow
+  - "Smart placement" for new windows
 
-0.0.4:
+0.0.5: BUG HUNT
 
-- Bugs
-  - TSubMenu keyboard mnemonic not working
-  - TDirectoryList cannot be navigated only with keyboard
-  - TTreeView cannot be navigated only with keyboard
-  - RangeViolation after dragging scrollbar up/down
+- TSubMenu keyboard mnemonic not working
+- ECMA48Terminal
+  - Mode 1006 mouse coordinates
 
-0.1.0:
+0.1.0: BETA RELEASE
 
-- TWindow
-  - "Smart placement" for new windows
+- TSpinner
+- TComboBox
+- TListBox
+- TCalendar
+- TColorPicker
 
 Wishlist features (2.0):
 
@@ -150,11 +181,6 @@ Wishlist features (2.0):
   - Handle resize events (pass to child process)
 - Screen
   - Allow complex characters in putCharXY() and detect them in putStrXY().
-- TComboBox
-- TListBox
-- TSpinner
-- TCalendar widget
-- TColorPicker widget
 - Drag and drop
   - TEditor
   - TField