summaryrefslogtreecommitdiffstats
path: root/libraries/cheapglk/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/cheapglk/README')
-rw-r--r--libraries/cheapglk/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/libraries/cheapglk/README b/libraries/cheapglk/README
new file mode 100644
index 0000000000..f5c0e95d03
--- /dev/null
+++ b/libraries/cheapglk/README
@@ -0,0 +1,10 @@
+cheapglk (cheapass implementation of the Glk API)
+
+This is the simplest possible implementation of the Glk API. It uses
+stdio.h calls (fopen, putc, getc), but not any of the curses.h calls
+(which handle cursor movement and unbuffered keyboard input.) So
+there's no way it can support multiple windows, or a status bar. In
+fact, this library only allows you to create *one* window at a time,
+and that must be a TextBuffer. Fortunately -- well, deliberately --
+TextBuffer windows are very simple; all the library has to be able to
+do is printf() straight to stdout.