aboutsummaryrefslogtreecommitdiff
path: root/util/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/README.md')
-rw-r--r--util/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/util/README.md b/util/README.md
new file mode 100644
index 0000000..3425336
--- /dev/null
+++ b/util/README.md
@@ -0,0 +1,11 @@
+Utility to turn symbolic keys into terminal input
+-------------------------------------------------
+
+This is a small helper utility which translates symbolic keys, as provided
+by [libtermkey](http://www.leonerd.org.uk/code/libtermkey/) and also used
+to specify key bindings within vis, to their corresponding codes understood
+by terminal programs.
+
+Type `make` to build the utility. `make keys-local` links the utility against
+a locally built version of libtermkey as produced by the top level `make local`
+Makefile target.