diff INSTALL @ 251:e9ea4ce4c697

Muchly improved documentation and installation instructions.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 21 Dec 2004 18:50:00 +0000
parents b02705a9b2d6
children d8f088079384
line wrap: on
line diff
--- a/INSTALL	Tue Dec 21 18:49:02 2004 +0000
+++ b/INSTALL	Tue Dec 21 18:50:00 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.
+For more information and tips, please refer to README and FAQ.
 
 Requirements
 ============
@@ -12,19 +12,55 @@
   GNU toolchain. I have no idea whether this compiles with
   any other compiler ... sorry.
 
-- You need AT LEAST one emulation library:
+- You need AT LEAST one of the following emulation libraries:
 
    * 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.
+  Only one emulator backend library is required, but all are
+  supported with run-time configuration. You may also need
+  some supplementary libraries for each emulator library.
+  See below for more information.
 
 
-NOTICE!  Refer to file README for recommendations about which
-emulator libraries you should install!
+Emulator library selection recommendations
+==========================================
+Some words on which emulation library you should choose to install
+and use - it depends somewhat on your system and personal preferences.
+
+- libSIDPlay v1: This is the old SIDPlay v1 emulation library. Its
+  emulation is "frame-based" and not very accurate. The waveforms
+  produced are harsher and emulation of SID filter is far from
+  accurate.
+
+  libSIDPlay v1 requires very little CPU power, it is faster and
+  may have fewer bugs due to being more mature software. Many
+  OS distributions have pre-built packages of it, not something that
+  can be said of libSIDPlay v2. Some people may even like the
+  harsher sound produced by libSIDPlay v1.
 
+  Drawbacks are: worse emulation, eventually weakening compability
+  as new SID-tunes/files are ripped into "RSID"-format which
+  libSIDPlay v1 does NOT support.
+
+
+- libSIDPlay v2: New, next generation modular SID-emulation framework.
+  Along with reSID-library it produces probably most accurate emulated
+  representation of SID-chip available. This, however, comes at high
+  cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the
+  selected emulation options. It is also less spread, not as many
+  distributions/operating systems come with pre-packaged libSIDPlay2,
+  so you may have to roll your own.
+
+  Also the API-stability of libSIDPlay2 is not yet 100%, there may
+  be changes. Bugs are evident, though many of them will be fixed
+  eventually.
+
+  
+Conclusion thus is as follows: If you are using an old system with not
+much spare CPU-power, choose libSIDPlay v1. On a relatively recent
+system (more powerful than Pentium III 500MHz) you may wish to choose
+libSIDPlay v2, although your mileage may vary.
 
 
 Where to get XMMS?
@@ -108,7 +144,7 @@
 
 Post-installation configuration
 ===============================
-To gain full advantages of using XMMS-SID, you need to configure it.
+To gain full advantage 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: