File	Date	Author	Commit
svgkeysmodules	2010-09-25	Marten Gajda	[f27cbe] fix broken quit action
.gitignore	2010-08-21	Marten Gajda	[d84c06] fix high cpu utilisation for hover effect
CHANGELOG	2010-09-25	Marten Gajda	[f27cbe] fix broken quit action
MANIFEST	2010-09-25	Marten Gajda	[f27cbe] fix broken quit action
MANIFEST.in	2010-08-18	Marten Gajda	[df7c1c] add GPL header to source files
README	2010-09-25	Marten Gajda	[f27cbe] fix broken quit action
setup.py	2010-09-25	Marten Gajda	[f27cbe] fix broken quit action
svgkeys	2010-08-18	Marten Gajda	[a8e42a] add GPL header to source files

Read Me

# svgkeys - SVG Keyboard
# Copyright (C) 2010  Marten Gajda
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# contact information:
# Marten Gajda <marten@dmfs.org>
#
# svgkeys version 0.2d

Index

0. ABOUT

1. REQUIREMENTS

2. INSTALLATION

3. USAGE

4. THEME CREATION

5. THANKS




0. ABOUT

svgkeys is a fully themeable virtual keyboard for X11. Its primary intended use
was to practise programming in Python. Since I don't own a tablet pc I have no
use for a virtual keyboard at all :-(. However, I'm willing to continue its
development if someone finds it useful (or donates a tablet pc to me ;-)


1. REQUIREMENTS

svgkeys is developed under GNU/Linux and Python 2.6. Earlier Python versions and
other operating systems may also do, but this is not tested.

Make sure you have installed the following modules:

* python-rsvg (librsvg-python in Gentoo)
* python-xlib

(or whatever they are called in your distro)

For full eye candy a compositing manager (compiz, xcompmgr, ...) is recommended.


2. INSTALLATION

Install svgkeys with the following commands

tar xzf svgkeys-<VERSION>.tar.gz
cd svgkeys-<VERSION>
python setup.py install


3. USAGE

Run svgkeys by executing

svgkeys

'svgkeys -h' gives a brief help about its command line parameters.

Currently there are three built-in themes available:

* dark.theme (default)
* glass.theme
* round.theme (not very useful, just a demo for shaped keys)

to use a different than the default theme run

svgkeys -t <THEME>

where THEME is a name of a theme-file. If THEME does not include a path
it is looked up in the "builtin" directory only.
All svg files are looked up relative to the directory of the theme-file.


4. THEME CREATION


Sorry, the theme files are not documented currently and are very likely to
change in future. As a starting point you can use the built-in themes from
the "builtin" directory in the archive. The theme files are XML and hopefully
quite self-explanatory.
Please contact me for details.


5. THANKS

Thanks go to Akkana Peck for demonstrating with pykey how to fake key strokes
in python.