About
=====

luminocity is a toy window manager and compositing manager that
uses OpenGL for display.

Compiling
=========

pkg-config requires:

 - Recent set of X libraries including the libraries for fixes,
   damage, composite, and xtest. The libraries of XOrg 6.8.1
   are fine, except that there is no .pc file for xtst.
   It should be easy to hack the Makefile to make up for that.

   The 'xlibs' libraries from freedesktop org CVS work well,
   and can be build easily with jhbuild.

 - libGL, libGLU

 - GLib-2.6.0 or newer.

Running
=======

You need to first start a target display. The target display
must support the Damage, XFIXES, COMPOSITE, and XTEST extensions.
The Xfake server that builds as part of the freedesktop.org
'xserver' module is a good choice.

 Xfake :1 -ac

Then start luminocity pointed to that display as the source.

 luminocity :1

The DISPLAY environment variable must be set to a display with
GL support.

Using
=====

Not exactly highly usable yet:

 - Super + Left button:    move
 - Super + Middle button:  resize
 - Super + Right button:   raise or lower

Copyright and License
=====================

Most of the code of luminocity is Copyright 2004, Red Hat Inc,
and licensed under the GNU General Public License.

The GL setup code is somewhat based on glxgears by Brian Paul
The Xdamage code to suck windows off the target server is based
on Keith Packard's 'lightpipe' library.

Contributing
============

A) Contributions to make it a cooler toy or a more useful test
    platform are gladly welcomed.

B) Contributions to make it more usable as a window manager will
   be grudgingly accepted as long they don't interfere with A.

--
Owen Taylor <otaylor@redhat.com>
29 October 2004

