OVERVIEW
========

Golem is an X11 Window Manager.  Design goals are that it be fast
and lightweight, as well as customizable in any way that will not
prevent the first goal from being realized.

The window manager's primary mechanisms for customizability are it's
ability to change the way window decoration looks (often called a
'theme'), and the ability to load plugins into the window manager
that modify it's behavior, or add a new user interface.
For information on how themes work, and writing your own themes,
read the file THEMES included with this distribution.  Likewise,
for information on plugins, how they work, and how to write your
own, read the file PLUGINS included with this distribution.

INSTALLATION
============

this is pretty normal; do:

% ./configure

or if you prefer, something like:

% env CFLAGS="-O2 -pipe -DNDEBUG" ./configure --prefix=/usr/X11R6

if you want xinerama support configure with --enable-xinerama;
you may build an optional sound effects plugin by passing
the --enable-sound option to configure (this plugin requires
the EsounD library).  After you have configured, do

% make
# make install

then as the user you intend to use golem as (not root!!), type

% golem.install

to install the golem configuration files in ~/.golem, as well as
make ~/.xsession and ~/.xinitrc files if you don't want to keep
your current ones.  Then if you log out of X, and then back in,
you should be in golem.

if you wish to get rid of it do

# make deinstall

and then, if you want, remove the files in ~/.golem.

BUGS
====

If you find a bug, check the TODO file distributed with this package to
see if it is mentioned there, if it is not, please send an email
to golem-devel@lists.sourceforge.net with a detailed description of the
problem, as well as instructions on how to reproduce, and if
applicable or possible a gdb backtrace.  Alternatively, you could just
fix it and send a patch.

LEGAL
=====

Golem is distributable under the terms of the BSD license; a copy of which
is found in the file LICENSE included with this distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
