X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=24b437a65a4dee26b1392ddda1033bc40860f3d8;hb=7c870d89433346ccb5505f8f9ba62d3fc18fe996;hp=8d8ea20d625c2a168b1695498dfcbfc813ba5bcd;hpb=92554d64c21c6a477fd23a06ca3a64a542b622a3;p=fanfix.git

diff --git a/README.md b/README.md
index 8d8ea20..24b437a 100644
--- 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,24 +17,34 @@ 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 VERY experimental, please consider filing bugs when you
-  encounter them.
+* 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.
 
 
 
 License
 -------
 
-This project is licensed LGPL ("GNU Lesser General Public License")
-version 3 or greater.  See the file LICENSE for the full license text,
-which includes both the GPL v3 and the LGPL supplemental terms.
+This project is licensed LGPL ("GNU Lesser General Public License",
+sometimes called the "Library GPL") version 3 or greater.  You may
+freely use Jexer in both closed source (proprietary) and open source
+applications, however any changes you make to the Jexer code must be
+made available to your users.
+
+See the file LICENSE for the full license text, which includes both
+the GPL v3 and the LGPL supplemental terms.
 
 
 
@@ -49,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.*;
@@ -57,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();
@@ -66,7 +77,7 @@ public class MyApplication extends TApplication {
 
     public static void main(String [] args) {
         MyApplication app = new MyApplication();
-        app.run();
+        (new Thread(app)).start();
     }
 }
 ```
@@ -82,6 +93,33 @@ Some arbitrary design decisions had to be made when either the
 obviously expected behavior did not happen or when a specification was
 ambiguous.  This section describes such issues.
 
+  TTerminalWindow
+  ---------------
+
+  - TTerminalWindow will hang on input from the remote if the
+    TApplication is exited before the TTerminalWindow's process has
+    closed on its own.  This is due to a Java limitation/interaction
+    between blocking reads (which is necessary to get UTF8 translation
+    correct) and file streams.
+
+  - 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.
+
 
 
 Roadmap
@@ -89,50 +127,53 @@ Roadmap
 
 Many tasks remain before calling this version 1.0:
 
-0.0.2:
+0.0.2: STABILIZE EXISTING
 
-- AWT:
+- TTerminalWindow
+  - Expose shell commands as properties
+- Swing:
   - Blinking cursor
+  - Block cursor
 - ECMA48Backend running on socket
+- TFileOpen
+- Document any properties used
+  - Expose use of 'stty'
+
+0.0.3: FINISH PORTING
+
 - TTreeView
+  - Also add keyboard navigation
 - TDirectoryList
-- TFileOpen
-- Decide on naming convention: getText, getValue, getLabel: one or all
-  of them?
+  - Also add keyboard navigation
 
-0.0.3:
+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
-  - TTimer is jittery with I/O
-  - TSubMenu keyboard mnemonic not working
-  - Making TMenu keyboard accelerators active/inactive
-  - 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
-- ECMATerminal
-  - Mouse 1006 mode parsing
+- TSpinner
+- TComboBox
+- TListBox
+- TCalendar
+- TColorPicker
 
 Wishlist features (2.0):
 
 - TTerminal
   - Handle resize events (pass to child process)
-  - xterm mouse handling
 - Screen
   - Allow complex characters in putCharXY() and detect them in putStrXY().
-- TComboBox
-- TListBox
-- TSpinner
-- TCalendar widget
-- TColorPicker widget
 - Drag and drop
   - TEditor
   - TField
@@ -144,3 +185,7 @@ Wishlist features (2.0):
 Screenshots
 -----------
 
+![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal")
+
+![Yo Dawg...](/screenshots/yodawg.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.")
+