path: root/libraries/remglk/README
diff options
Diffstat (limited to 'libraries/remglk/README')
1 files changed, 9 insertions, 0 deletions
diff --git a/libraries/remglk/README b/libraries/remglk/README
new file mode 100644
index 0000000000..9fb8594168
--- /dev/null
+++ b/libraries/remglk/README
@@ -0,0 +1,9 @@
+remglk (remote-procedure-call implementation of the Glk IF API)
+remglk is an implementation of the Glk Interactive Fiction library which
+supports structured input and output.
+RemGlk does not provide a user interface. Instead, it wraps up the
+application's output as a JSON data structure and sends it to stdout. It
+then waits for input to arrive from stdin; the input data must also be
+encoded as JSON.