@@ -1,6 +1,10 @@
1vty is a terminal interface library.
1vty is a terminal interface library.
3−Vty currently provides:
3+Project is hosted on github.com: https://github.com/coreyoconnor/vty
5+git clone git://github.com/coreyoconnor/vty.git
5* Automatic handling of window resizes.
9* Automatic handling of window resizes.
@@ -29,7 +33,7 @@ Vty currently provides:
30* Properly handles cleanup.
34* Properly handles cleanup.
32−Current disadvantages:
36+# Known Issues
34* The character encoding of the output terminal is assumed to be UTF-8.
38* The character encoding of the output terminal is assumed to be UTF-8.
@@ -40,11 +44,13 @@ Current disadvantages:
40* Uses the TIOCGWINSZ ioctl to find the current window size, which
44* Uses the TIOCGWINSZ ioctl to find the current window size, which
41 appears to be limited to Linux and *BSD.
45 appears to be limited to Linux and *BSD.
43−Project is hosted on github.com: https://github.com/coreyoconnor/vty
47+# Platform Support
45−git clone git://github.com/coreyoconnor/vty.git
49+## Posix Terminals
51+Uses terminfo to determine terminal protocol. Some special rules for Mac terminal applications. The
52+special rules might be invalid on newer Mac OS.
47−To compile the demonstration program: ghc --make test/Test.hs gwinsz.c
54+## Windows
49−The main documentation consists of the haddock-comments and the demonstration
56+None!