X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=4acc5251ebc7433a151b74a65c60227889c7fe3f;hb=a4406f4ed7f163b7ab0adce2e710b74d1175b1f3;hp=570a0170c095aaf55cc2f6d15ef4ad13839f633f;hpb=bd8d51fa0a33d6d27dba088c57791e1650512fc0;p=nikiroo-utils.git

diff --git a/README.md b/README.md
index 570a017..4acc525 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,25 +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 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.
 
 
 
 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.
 
 
 
@@ -50,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.*;
@@ -58,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();
@@ -67,7 +77,7 @@ public class MyApplication extends TApplication {
 
     public static void main(String [] args) {
         MyApplication app = new MyApplication();
-        app.run();
+        (new Thread(app)).start();
     }
 }
 ```
@@ -87,63 +97,78 @@ ambiguous.  This section describes such issues.
   ---------------
 
   - TTerminalWindow will hang on input from the remote if the
-    TApplication is exited before closing the TTerminalWindow.  This
-    is due to a Java limitation/interaction between blocking reads
-    (necessary to get UTF8 translation correct) and file streams.
+    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()).
+
+
 
 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
-  - Handle kbTab (disable focus traversal BS)
+  - Block cursor
 - ECMA48Backend running on socket
-- TTreeView
-- TDirectoryList
 - TFileOpen
 - Decide on naming convention: getText, getValue, getLabel: one or all
   of them?
+- Refactor:
+  - TKeypress:
+    - 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
-  - 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
 
-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
@@ -157,3 +182,5 @@ 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.")
+