Permalink
Browse files

doc updates

  • Loading branch information...
1 parent 53d501b commit cca1f9aa5be6821eb9f541b58adc94e17f4f1f63 @coreyoconnor coreyoconnor committed Mar 22, 2013
Showing with 14 additions and 8 deletions.
  1. +13 −7 README
  2. +1 −1 src/Graphics/Vty/Terminal/MacOSX.hs
View
@@ -1,6 +1,10 @@
vty is a terminal interface library.
-Vty currently provides:
+Project is hosted on github.com: https://github.com/coreyoconnor/vty
+
+git clone git://github.com/coreyoconnor/vty.git
+
+# Features
* Automatic handling of window resizes.
@@ -29,7 +33,7 @@ Vty currently provides:
* Properly handles cleanup.
-Current disadvantages:
+# Known Issues
* The character encoding of the output terminal is assumed to be UTF-8.
@@ -40,11 +44,13 @@ Current disadvantages:
* Uses the TIOCGWINSZ ioctl to find the current window size, which
appears to be limited to Linux and *BSD.
-Project is hosted on github.com: https://github.com/coreyoconnor/vty
+# Platform Support
-git clone git://github.com/coreyoconnor/vty.git
+## Posix Terminals
+
+Uses terminfo to determine terminal protocol. Some special rules for Mac terminal applications. The
+special rules might be invalid on newer Mac OS.
-To compile the demonstration program: ghc --make test/Test.hs gwinsz.c
+## Windows
-The main documentation consists of the haddock-comments and the demonstration
-program
+None!
@@ -1,4 +1,4 @@
--- Copyright 2009-2010 Corey O'Connor
+-- Copyright Corey O'Connor
-- The standard Mac OS X terminals Terminal.app and iTerm both declare themselves to be
-- "xterm-color" by default. However the terminfo database for xterm-color included with OS X is
-- incomplete.

0 comments on commit cca1f9a

Please sign in to comment.