commit 07b4b3e51683dc905bce4217cfa97c63d80f7e38
parent 6ad5403859ab6e7f4480c3122de240bf7020cf8d
Author: Enno Boland (tox) <tox@s01.de>
Date: Fri, 25 Mar 2011 15:39:00 +0100
Adding README
Diffstat:
| README | | | 29 | +++++++++++++++++++++++++++++ |
1 file changed, 29 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,29 @@
+svkbd - simple virtual keyboard
+===============================
+svkbd is a small X client application usefull for emulating a keyboard
+on the screen.
+
+
+Requirements
+------------
+In order to build svkbd you need the Xlib and XTest header files.
+
+
+Installation
+------------
+Edit config.mk to match your local setup (svkbd is installed into
+the /usr/local namespace by default).
+
+Afterwards enter make svkbd.<LAYOUT> to compile svkbd, where <LAYOUT> can
+be one of de, en, arrows. "make" defaults to svkbd.en, which is copied to
+svkbd
+
+Configuration
+-------------
+The configuration of svkbd is done by creating a custom config.h
+and (re)compiling the source code.
+
+You can define your own keyboard layouts by creating layout.<IDENTIFIER>.h.
+Afterwards, build your customized version by executing
+
+ make svkbd.<IDENTIFIER>
