aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjluehrs2 <jluehrs2@uiuc.edu>2008-03-14 13:00:57 -0500
committerjluehrs2 <jluehrs2@uiuc.edu>2008-03-14 13:00:57 -0500
commit8fb3d9f1d6c3750e3418e1f89e8d58d519e1db00 (patch)
tree6d53de9b3d0cb5bf938a5a57beb6f4bda737e013
parenteb8a8c5f10be322004d8f926fae8998c4b8a150d (diff)
downloadluancurses-8fb3d9f1d6c3750e3418e1f89e8d58d519e1db00.tar.gz
luancurses-8fb3d9f1d6c3750e3418e1f89e8d58d519e1db00.zip
reorganize readme/todo
-rw-r--r--README28
-rw-r--r--TODO5
2 files changed, 30 insertions, 3 deletions
diff --git a/README b/README
index d67d364..1df725f 100644
--- a/README
+++ b/README
@@ -1,3 +1,25 @@
-not supporting printing
-not supporting formatted reads and writes (use string.format/string.match)
-not supporting termcap or terminfo stuff
+LuaNcurses v0.01
+Jesse Luehrs (jluehrs2@uiuc.edu)
+
+OVERVIEW
+========
+Lua-ncurses is a wrapper around the ncurses library for terminal programming. It aims to expose the ncurses library in a way that is more natural to Lua programmers, rather than just be a thin wrapper around C function calls. It is currently rather incomplete, but most basic functionality is available.
+
+INSTALL
+=======
+This module requires Lua 5.1. To install, modify the Make.config file with paths appropriate to your system and run 'make' and 'make install'.
+
+DOCUMENTATION
+=============
+None yet, but hopefully the included tests should be explanatory enough for now. Real docs should be available in a later release.
+
+CHANGES
+=======
+0.1
+- Initial basic implementation
+
+COPYRIGHT AND LICENSE
+=====================
+Copyright (C) 2008 Jesse Luehrs
+
+This code is distributed under the MIT license; a copy is in the LICENSE file distributed with the source.
diff --git a/TODO b/TODO
index 53ea489..d60b25f 100644
--- a/TODO
+++ b/TODO
@@ -24,3 +24,8 @@
- trace debugging (curs_trace)
- ncurses extensions (curs_extend, define_key, default_colors, curs_getch (has_key), key_defined, keybound, keyok, resizeterm)
- misc curses utils (curs_util)
+
+not supporting:
+- printing
+- formatted reads and writes (use string.format/string.match)
+- termcap or terminfo stuff