This document describes overall requirements and procedure
for installation of XMMS-SID package, please read it carefully!
For more tips, please also read README and FAQ.

Requirements
============
- XMMS version 1.2.0 or later (http://www.xmms.org/)

- Gtk+ and Glib 1.2.5 or later (http://www.gtk.org/)

- C and C++-compiler. Preferably GCC along with rest of the
  GNU toolchain. I have no idea whether this compiles with
  any other compiler ... sorry.

- You need AT LEAST one emulation library:

   * libSIDPlay1
   * libSIDPlay2

Only one is required, but all are supported. You may also need
some supplementary libraries, that  are required by the emulator
library. See below for more information.


NOTICE!  Refer to file README for recommendations about which
emulator libraries you should install!



Where to get XMMS?
==================
Latest version of XMMS should be available from:

http://www.xmms.org/

Please refer to XMMS documentation for information on its usage
and installation, etc. You probably have XMMS already installed,
but if you installed from a pre-built package, make sure that
you have corresponding xmms-devel -package also.


Where to get libSIDPlay1?
=========================
libSIDPlay1 is available at SIDPlay's homepage:

http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html

You only need libsidplay, the sidplay-base is not necessary
if you are sure that you don't need the commandline player.


Where to get libSIDPlay2?
=========================
libSIDPlay2 is available at SourceForge:

http://sidplay2.sourceforge.net/

You need the "sidplay-libs-2.1.0" package! Earlier versions WILL NOT
WORK! Later versions MAY work, but I can't really guarantee that.


Building a CVS-version
======================
To build a CVS-version of XMMS-SID, you need to have latest
(STABLE) versions of following tools installed, including:

 - GNU autoconf 2.56 or newer
 - GNU automake 1.7 (older and newer versions MAY be incompatible!)
 - GNU libtool 1.5.6 or newer
 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4)

If you have all required tools installed, just run the
"bootstrap.sh"-script which generates all necessary build-files.
After successfull bootstrapping, you  should be able to install
the package normally, following steps described in next chapter.


Installing XMMS-SID
===================
When you have the requirements installed and working succesfully,
you may try compiling and installation of XMMS-SID.

Invoke configure script (use parameter --help for help)

$ ./configure

The configure-script will print out lots of information and in
the end it tells you some of the selected build options.

If configure passed without errors, try compilation. (Depending
on your system, you may need to invoke 'gmake' instead of 'make'.)

$ make

If that went OK too, then you may try installation. Again, you
may need to invoke 'gmake' instead of 'make'. Install globally
to whole system (as root):

# make install

or install for current user only:

$ make install-user

Assuming all went correctly, XMMS-SID should now be installed.
You should now start or re-start XMMS and configure XMMS-SID's
various options.


Post-installation configuration
===============================
To gain full advantages of using XMMS-SID, you need to configure it.
XMMS-SID can be configured just like any other XMMS plugin, in XMMS
do as follows:

 -> Press <ctrl+p>
 -> Select "Audio I/O Plugins"-tab
 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list
 -> Click "Configure"

Please refer to README for more information about configuration.