From 07b4b3e51683dc905bce4217cfa97c63d80f7e38 Mon Sep 17 00:00:00 2001 From: "Enno Boland (tox)" Date: Fri, 25 Mar 2011 15:39:00 +0100 Subject: [PATCH] Adding README --- README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..f971846 --- /dev/null +++ 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. to compile svkbd, where 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..h. +Afterwards, build your customized version by executing + + make svkbd.