view INSTALL @ 156:a57fb0799259

Cleanups
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 09 Mar 2004 21:12:00 +0000
parents e85ea6735767
children b80986b4f510
line wrap: on
line source

This document describes overall requirements and procedure
for installation of XMMS-SID package, please read it carefully!


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 and g++, I have no idea
  whether this compiles with any other compilers ... sorry.

- You need AT LEAST one emulation library:

   * libSIDPlay1
   * libSIDPlay2
   * NanoSID

  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.


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

http://www.xmms.org/

Please refer to XMMS documentation for information
on it's usage and installation (etc).


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.


Where to get NanoSID?
=====================
libNanoSID is available from LolOLOlo's pages:

http://www.sid6581.org/NanoSID/

The configure looks the "libNanoSID.a" and "libNanoSID.h"
from the standard locations, but you can also specify them
yourself if you don't wish to "install" them.


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 later
 - GNU automake 1.7 or later
 - GNU libtool 1.5 or later
 - 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 can
continue to install the package normally.


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

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

$ ./configure

You may need to select which version of libSIDPlay you want to
use by specifying either --with-sidplay1 or --with-sidplay2
options. If none are specified, configure will use the first
one found.

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 (as root, if
you are installing globally for the system). Again, you may need
to invoke 'gmake' instead of 'make'.

# make install

If everything went as supposed, you may now try (re)starting XMMS
and go play with your shiny new XMMS-SID-plugin! :-)