diff README @ 171:78e06aecad7f

Updated documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 13 Aug 2004 06:39:04 +0000
parents d3425d53be3a
children 7515712b4af7
line wrap: on
line diff
--- a/README	Thu Aug 12 01:43:03 2004 +0000
+++ b/README	Fri Aug 13 06:39:04 2004 +0000
@@ -18,11 +18,58 @@
 engines, including the excellent libSIDPlay v1 and v2.
 
 
-Requirements and installation
-=============================
-See file "INSTALL" for information about what XMMS-SID requires,
+Installation requirements and recommendations
+=============================================
+Refer to file "INSTALL" for information about what XMMS-SID requires,
 where to get those required packages and how to install.
 
+Some words on which emulation library you should select - 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 if 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
+  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.
+
+  
+- libNanoSID: An obscure binary-only emulation library which only plays
+  special ZSID-format files, which are not compatible with PSID-formats.
+  Pros: Fast emulation, supposedly good filter-emulation.
+  Cons: Does not support normal PSID-files directly, binary-only library
+  which only works on x86-Linux architechture.
+
+
+Conclusion thus is as follows: If you are using an old system with not
+much spare CPU-power, choose libSIDPlay v1. On a new system (more
+powerful than Pentium III 650MHz at least) you may choose libSIDPlay v2.
+
+libNanoSID is for those who need support for ZSID-format, most people
+don't have any reason to concern themselves with it.
+
 
 Usage
 =====