This document includes:

* Licensing
* General information
* Requirements


* Licensing

The Gle library is released under the terms of the GNU LGPL (GNU LIBRARY
GENERAL PUBLIC LICENSE).
Read the file COPYING.LIB for more information.

The rest of the code is released under the terms of the GNU GPL (GNU GENERAL
PUBLIC LICENSE).
Read the file COPYING for more information.


* General information

Gle is the layout engine for the the Gtk+ toolkit implemented as a shared
library which can be loaded as a Gtk-module against running Gtk programs.
To use Gle with an existing Gtk application, you just have to compile and
install this package and invoke your Gtk programs with an additional argument
--gtk-module=gle. E.g. to start testgtk from the Gtk+ distribution, you'd
invoke it as

sh</usr/src/gtk+/gtk>$ ./testgtk --gtk-module=gle

As an alternative, and for applications which make instant use of Gle's
programming interface, Gle can be explicitely linked against Gtk programs
and get initialized through a function call:

In the main() function of your gtk program add the initialization
for the Gle module either after the initialization of Gtk or solely, thus
skipping the call to gtk_init() which Gle will in this case take care of
automatically.

int main (int argc, char *argv[])
{
  [...]
  
- gtk_init (&argc, &argv);
+ gle_init (&argc, &argv);

  [...]
}

You then need to relink your program with the GLE library by
adding the "-lgle" option to your compiler/linker, e.g.

sh<~>$ gcc my-fancy-app.c `gtk-config --cflags` `gtk-config --libs` -lgle -o runme

Now after you have invoked ./runme, you can press <Ctrl>+<Alt>+<Tab>
in any of the Gtk windows that your application creates, and the GLE
shell will popup.

Further information about Gle can be found in the ./docs directory,
descending from the one this file resides in.
New users are recommended to read through ./docs/introduction.txt,
to get at least remotely informed on how to use Gle's GUI ;)


* Requirements

The GLE library depends on a couple of extra packages
in order to work properly:

	- The latest Gtk+: This is the release of the Gtk+ toolkit.
	  You can find Gtk+ releases at:
	  
	  ftp://ftp.gtk.org/pub/gtk/


* Getting GLE

GLE has it's own web page from which you can get the latest release:

http://www.SoftHome.net/pub/users/timj/gle/index.htm


Have fun,

	Tim Janik <timj@gtk.org>
