README

This is the Keyboard Layout Editor, a pygtk program that helps create or edit XKB keyboard layouts.

This is the version that has been submitted to the GSoC xorg project; you can find the latest version
at http://github.com/simos/keyboardlayouteditor/tree/master

The home page of the Keyboard Layout Editor is
http://code.google.com/p/keyboardlayouteditor/

You are strongly encouraged to use the version that is found at the above URL, 
as it includes several bug fixes.

The project was developed using Eclipse (Ganymede), with the Python (PyDev) and Antlr (AntlrIDE) add-ons.
If you also have SVN support in Eclipse, you can grab the latest source from within Eclipse.
There is also integration with Mylene so that you can get the list of issues/bugs/todo items 
automatically.

To run the application, you need the python binding packages for 
* Cairo
* Pango
* GObject
* lxml

and the Antlr 3.1.2 Runtime environment for Python. You grab that at 
http://antlr.org/download/Python/
Choose the appropriate *.egg file for the 3.1.2 version, then type

sudo easy_install antlr_python_runtime-3.1.2-py2.5.egg

('easy_install' is part of the 'python-setuptools' package; it is not installed by default).

You need to process the ANTLR grammars in order to generate the necessary Python code.
All *.g files should be processed with ANTLR.
You can get the ANTLR 3.1.2 package from http://www.antlr.org/download/antlr-3.1.2.jar
Assuming you installed Antlr 3.1.2 in your CLASSPATH, you compile a grammar (*.g) with
  java org.antlr.Tool *.g

Here is a practical example with Antlr 3.1.2.
  sudo apt-get install python-setuptools
  wget http://antlr.org/download/Python/antlr_python_runtime-3.1.2-py2.5.egg
  sudo easy_install antlr_python_runtime-3.1.2-py2.5.egg
  wget http://antlr.org/download/antlr-3.1.2.jar
  export CLASSPATH=$CLASSPATH:antlr-3.1.2.jar       
  java org.antlr.Tool *.g

You finally run this program with 

./KeyboardLayoutEditor