many fixes

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index a58e024c2930fff1aab09040e51298a601f926a4..570a0170c095aaf55cc2f6d15ef4ad13839f633f 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' .
@@ -75,6 +76,25 @@ See the file demos/Demo1.java for detailed examples.
 
 
 
+Known Issues / Arbitrary Decisions
+----------------------------------
+
+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 closing the TTerminalWindow.  This
+    is due to a Java limitation/interaction between blocking reads
+    (necessary to get UTF8 translation correct) and file streams.
+
+  - See jexer.tterminal.ECMA48 for more specifics of terminal
+    emulation limitations.
+
+
 Roadmap
 -------
 
@@ -84,7 +104,7 @@ Many tasks remain before calling this version 1.0:
 
 - AWT:
   - Blinking cursor
-- Clean up TWidget constuctors (everyone is doing setX() / setY() / set...)
+  - Handle kbTab (disable focus traversal BS)
 - ECMA48Backend running on socket
 - TTreeView
 - TDirectoryList
@@ -99,10 +119,8 @@ Many tasks remain before calling this version 1.0:
 0.0.4:
 
 - Bugs
-  - Bare ESC isn't being returned immediately
-  - TTimer is jittery with I/O
   - TSubMenu keyboard mnemonic not working
-  - kbDel and use by TMenu (MID_CLEAR)
+  - 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
@@ -132,3 +150,10 @@ Wishlist features (2.0):
   - TText
   - TTerminal
   - TComboBox
+
+
+Screenshots
+-----------
+
+![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal")
+