0) COPYRIGHT
------------
Please read the COPYRIGHT file.

But... thank you for taking a look at this for me.. any and all
feedback is welcome and appreciated.

0.0) If you get it working, please send me the output of
the test script. (test.sh)

[ This will output, the type of CPU you are using, how heavily loaded
your machine was when the test was run and some figures on how well
the test performed on your machine. ]

1) BUILDING
-----------
On FreeBSD you should be able to get the port/package from

http://www.pepcross.com/xglurbules/

On your run of the mill Unix box, you should just be able to type

make

This may not work for you, if you can edit the Makefile and get it to
work then that's cool, if not send me the output that you get with
make and I'll try and fix it for you! Or send me a patch for your OS!

Just so you know: you may not like my code. That's okay, I don't either.

2) RUNNING IT
-------------
Assuming it built fine, which is possible, if not likely, then you
should have two executable :

	xglurbules
and
	xglurbules_noshm

You could try running either, both should catch (most) signals and
clear up after themselves. I'm not promising anything, but they should
be fine.

However with any program that uses shared memory check out "ipcs(1)",
hopefully you have a manpage there. It will show if you've shared
memory segments not being cleared up. It *could* happen, if you kill
an XSHM program in a way it can't handle.
 e.g. kill -9 pid_of_xglurbules


3) USAGE
--------
keyboard controls are explained on screen (in the terminal you run it
from)

Command Line Switches for both xglurbules and xshmglurbules :

        -h        : Show help
        -l <num>  : Only show <num> frames (before quitting)
        -n <num>  : set number of particles to <num>
        -x <xres> : set x resolution
        -y <yres> : set y resolution
        -r        : run in root window
        -m        : randomly change force modes
        -b <0-255>: Set particle brightness
        -f        : Show frames per second
        -c <color>: Run with a colormap based on a given color
                  : e.g. -c 0xffaa66 for shades of orange
                  :      -c 0xaaccff for shades of something?!

e.g. 
./xshmglurbules -x 640 -y 512 -n 20000 -f -c 0xfce3f6
	(wow, what a vile colour that is!)

4) LUCK
-------
of the Good and best of varieties.


5) FEEDBACK
-----------
I'd love to hear your feedback, I've even included a test script for
you to run. email me at:

	 steve@pepcross.com

Comments, suggestions, bug reports, are all welcome. Please don't
flame me if it doesn't work or unexpectedly trashes your system, it's
not intended to and I apologise in advance if someone goes wrong and
causes you a problem, I'm only trying to write something that looks
nice and is a bit of fun not destroy the world (or your computer!).


