Adding README

This commit is contained in:
Enno Boland (tox) 2011-03-25 15:39:00 +01:00
parent 6ad5403859
commit 07b4b3e516
1 changed files with 29 additions and 0 deletions

29
README Normal file
View File

@ -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>