
 Installation instructions for Sherman's aquarium
--------------------------------------------------

PLEASE read it all!

But quick installation for those that still don't want to read on:

./configure
make
make install (become root might be required.)


 Required libraries and programs
---------------------------------

You need a working gnome installation if you want to use Sherman's
aquarium as a gnome applet.
All gnome versions >= 1.2.x are supported. 

There are several different choises of installation:
 - wmapplet only
 - wmapplet and gnome 1.x (with gtk+ 1.2.x)
 - wmapplet and gnome 2.x (with gtk+ 2.0.x)

For Xscreensaver and fullscreen support you need libSDL >= 1.2.0 

All is automagically detected by the configure script, so you won't
need to do something really.
Even if you want to use Sherman's aquarium as a wmapplet, and has a 
gnome installed, I urge you to compile it with gnome support.
Then you will have a preference window and the settings will be saved.

wmapplet only requires gtk+ 1.2 and gdk-pixbuf OR gtk+ 2.0(gdk-pixbuf
is included in 2.0)

For the gnome 1.x, a working gnome installation is required, including
gtk+ 1.2.x and gdk-pixbuf.

For the gnome 2.x, a working gnome installation is required, including
gtk+ 2.0.x.

Don't try gnome 2.x and gtk+ 1.2.x or gnome 1.x and gtk+ 2.x! That won't
compile! 


 Supported Operative Systems and limitations
----------------------------------------------
Linux, FreeBSD and Mac OSX/Darwin are fully supported with all features.
For all other unixs, the CPU load meassurement is turned off.
If you want to have the thermometer feature for your favorite
unix system and are prepared to do some testing, please don't hessitate
to mail me!

 Configure options
--------------------
 --disable-clock	Removes the code for clock displaying
 --disable-leds		Removes the code for showing the status 
			of the keyboard leds
			
 --disable-thermometer  Removes the code for CPU load measuring 
			on a thermometer scale
 --disable-matrix       Removes the code for the matrix scroller
 --disable-gnome        Removes the code for gnome applet support 
			and preferences window
 --disable-gnome2       Removes the code for gnome2 applet support and
			uses gnome1 if installed
 --disable-fullscreen   Removes the code for xscreensaver and fullscreen 
		        support
 --disable-gtk2         Forces use of gtk+ version 1.2.x even if 
			version 2.0.x exists.

 Installation
--------------
run ./configure with your options afterwards.
Check that everything went well.
Then write "make"
and when that is done, do a "make install"
To to a "make install", you will probably need to be root.

In gnome v1.x, Sherman's aquarium will now be installed under 
"Applets/Amusements". And in Gnome v2.x it's under "Amusements"
(I thought that would be best suited.)

Read the XSCREENSAVER file for how to install Sherman's aquarium
as a xscreensaver.

Any problems? I hope not. If you hit some, please mail me! 
Jonas Aaberg <cja@gmx.net>


