diff INSTALL @ 171:78e06aecad7f

Updated documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 13 Aug 2004 06:39:04 +0000
parents b80986b4f510
children be1cf864f28e
line wrap: on
line diff
--- a/INSTALL	Thu Aug 12 01:43:03 2004 +0000
+++ b/INSTALL	Fri Aug 13 06:39:04 2004 +0000
@@ -1,6 +1,6 @@
 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
 ============
@@ -8,8 +8,9 @@
 
 - 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.
+- 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:
 
@@ -17,9 +18,14 @@
    * 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.
+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?
@@ -28,8 +34,10 @@
 
 http://www.xmms.org/
 
-Please refer to XMMS documentation for information
-on it's usage and installation (etc).
+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?
@@ -48,9 +56,8 @@
 
 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.
+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?
@@ -69,23 +76,23 @@
 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
+ - GNU autoconf 2.56 or newer
+ - GNU automake 1.7 (older and newer versions MAY be incompatible!)
+ - GNU libtool 1.5 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.
+"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 can try compiling 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)
+Invoke configure script (use parameter --help for help)
 
 $ ./configure