run jexer inside jexer

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index c2946c69e8b8a6fe1f0756ff49bff73c35782259..89e852a1213fcf9a44d9ec617a6926293e8106bd 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,28 @@ 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 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
 -------
 
@@ -82,15 +105,22 @@ Many tasks remain before calling this version 1.0:
 
 0.0.2:
 
-- Fix clipping errors
+- 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:
 
@@ -99,9 +129,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
@@ -110,14 +138,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
@@ -131,3 +156,13 @@ 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")
+
+![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.")