merge

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index 8d8ea20d625c2a168b1695498dfcbfc813ba5bcd..746b1686b171904fea0def6e1652015e9561ad60 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' .
@@ -82,6 +83,17 @@ 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.
 
 
 Roadmap
@@ -91,14 +103,22 @@ 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:
 
@@ -107,9 +127,7 @@ Many tasks remain before calling this version 1.0:
 0.0.4:
 
 - 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
@@ -144,3 +162,5 @@ Wishlist features (2.0):
 Screenshots
 -----------
 
+![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal")
+