fix eclipse warnings
[nikiroo-utils.git] / README.md
index ce707711f14c465735302502487b991dd234b186..583957cf11414fe93e2df0a7a3ae7e3edbed1a80 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,8 +20,9 @@ Two backends are available:
 
 * 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.
+  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.
 
 A demo application showing the existing UI controls is available via
 'java -jar jexer.jar' or 'java -Djexer.AWT=true -jar jexer.jar' .
@@ -31,9 +32,14 @@ A demo application showing the existing UI controls is available via
 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.
 
 
 
@@ -91,6 +97,11 @@ ambiguous.  This section describes such issues.
     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.
+
+
+
 
 Roadmap
 -------
@@ -102,8 +113,8 @@ Many tasks remain before calling this version 1.0:
 - Making TMenu keyboard accelerators active/inactive
 - AWT:
   - Blinking cursor
+  - Handle kbTab (disable focus traversal BS)
   - Block cursor
-  - Fix mouse artifacts
 - ECMA48Backend running on socket
 - TTreeView
 - TDirectoryList
@@ -118,6 +129,7 @@ Many tasks remain before calling this version 1.0:
 
 0.0.3:
 
+- TStatusBar
 - TEditor
 
 0.0.4:
@@ -132,14 +144,11 @@ Many tasks remain before calling this version 1.0:
 
 - TWindow
   - "Smart placement" for new windows
-- ECMATerminal
-  - Mouse 1006 mode parsing
 
 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
@@ -160,3 +169,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.")
+