fix eclipse warnings
[nikiroo-utils.git] / README.md
index 570a0170c095aaf55cc2f6d15ef4ad13839f633f..583957cf11414fe93e2df0a7a3ae7e3edbed1a80 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,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.
 
 
 
@@ -87,14 +92,17 @@ 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.
 
 
+
+
 Roadmap
 -------
 
@@ -102,25 +110,32 @@ Many tasks remain before calling this version 1.0:
 
 0.0.2:
 
+- Making TMenu keyboard accelerators active/inactive
 - AWT:
   - 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
 
 0.0.3:
 
+- TStatusBar
 - TEditor
 
 0.0.4:
 
 - 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
@@ -129,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
@@ -157,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.")
+