comparison INSTALL @ 391:3cc7455360ad

Improve documentation: Talk more about libSIDPlay1, document problems of libSIDPlay2 and approximate installation procedure.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 30 May 2006 04:50:04 +0000
parents 7b6ec6ee418d
children eff5ea454bae
comparison
equal deleted inserted replaced
390:fcf4f13d73a0 391:3cc7455360ad
75 you have corresponding xmms-devel -package also. 75 you have corresponding xmms-devel -package also.
76 76
77 77
78 Where to get libSIDPlay1? 78 Where to get libSIDPlay1?
79 ========================= 79 =========================
80 libSIDPlay1 is available at SIDPlay's homepage: 80 Your OS distribution or some supplementary package repository
81 may contain libSIDPlay1 packages. Usually those should work
82 well, but remember to also install the corresponding -dev/-devel
83 package.
84
85 If you can't find packages for your OS, source tarballs for
86 libSIDPlay1 are available at SIDPlay's homepage:
81 87
82 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html 88 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html
83 89
84 You only need libsidplay, the sidplay-base is not necessary 90 You only need libsidplay, the sidplay-base is not necessary
85 if you are sure that you don't need the commandline player. 91 if you think that you do not need the commandline player.
86 92
87 93
88 Where to get libSIDPlay2? 94 Where to get libSIDPlay2?
89 ========================= 95 =========================
90 libSIDPlay2 is available at SourceForge: 96 As of now, some OS distributions already include libSIDPlay2
97 packages, but some of those may be too old or incompatible
98 with XMMS-SID. Also note, that ONLY the latest CVS version
99 (as of 28.5.2006) of libSIDPlay2 compiles correctly with
100 GCC 4.x - older versions trigger a GCC4 bug, which causes
101 tunes to play too fast!
102
103 The fixed versions are available as source tarballs
104 (and RPMs for Fedora Core 3) and I highly recommend that
105 you use these versions. Please refer to:
106
107 http://www.tnsp.org/xmms-sid.php#download
108
109
110 However, the original home of libSIDPlay2 is at SourceForge:
91 111
92 http://sidplay2.sourceforge.net/ 112 http://sidplay2.sourceforge.net/
93
94 You need the "sidplay-libs-2.1.1" package! Earlier versions WILL NOT
95 WORK! Later versions MAY work, but I can't really guarantee that.
96 113
97 114
98 Building a CVS-version 115 Building a CVS-version
99 ====================== 116 ======================
100 To build a CVS-version of XMMS-SID, you need to have latest 117 To build a CVS-version of XMMS-SID, you need to have latest
101 (STABLE) versions of following tools installed, including: 118 (STABLE) versions of following tools installed, including:
102 119
103 - GNU autoconf 2.56 or newer 120 - GNU autoconf 2.56 or newer
104 - GNU automake 1.7 (older and newer versions MAY be incompatible!) 121 - GNU automake 1.9 (older and newer versions MAY be incompatible!)
105 - GNU libtool 1.5.6 or newer 122 - GNU libtool 1.5.20 or newer
106 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4) 123 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4)
107 124
108 If you have all required tools installed, just run the 125 If you have all required tools installed, just run the
109 "bootstrap.sh"-script which generates all necessary build-files. 126 "bootstrap.sh"-script which generates all necessary build-files.
110 After successfull bootstrapping, you should be able to install 127 After successfull bootstrapping, you should be able to install
111 the package normally, following steps described in next chapter. 128 the package normally, following steps described in next chapter.
112 129
113 130
114 Installing libSIDPlay2 131 Installing libSIDPlay2
115 ====================== 132 ======================
133 NOTICE! The upstream libSIDPlay2 has several bugs in build
134 scripts, which botch up building on some non-mainstream
135 platforms, such as NetBSD and Solaris. I personally provide
136 fixed versions of libSIDPlay2, reSID and reSID-builder
137 packages. Therefore I highly recommend that you use the
138 fixed versions I provide on XMMS-SID's homepage (see above).
139
140
141 NOTICE #2! Under Solaris you may run into a linking problem,
142 because of a bug in GCC's libtool, please read following
143 mailing list thread for more information:
144
145 http://lists.gnu.org/archive/html/libtool/2005-08/msg00021.html
146
147
116 As the installation procedure of libSIDPlay2 is not completely 148 As the installation procedure of libSIDPlay2 is not completely
117 transparent or simple, I describe here the steps how to do it 149 transparent or simple, I describe here the steps how to do it
118 (hopefully) in a succesful manner: 150 (hopefully) in a succesful manner:
119 151
120 1) Get libsidplay2, resid and resid-builder packages, which 152 1) Get libSIDPlay2, reSID and reSID-builder packages.
121 are now available from XMMS-SID's homepage too. 153
122 154 2) Build reSID (you may need to invoke 'gmake' instead of 'make'):
123 2) In following order, 155
124 156 tar -xzvf resid-0.16.2-ccr.tar.gz
125 157 cd resid-0.16.2-ccr
158 ./configure
159 make
160
161 There is no need to do "make install", just leave the
162 build directory intact, you will need the contents when
163 compiling reSID-builder below.
164
165 3) Build libSIDPlay2 similarly, but this time do install.
166 Untar the package as usual and ...
167
168 ./configure
169 make
170 make install
171
172 You have to do "make install" as root.
173
174 4) Build reSID-builder in similar manner, but with specific
175 configure parameters. As usual, untar the package and ...
176
177 ./configure --with-resid=/path/to/resid-0.16.2-ccr
178 make
179 make install
180
181 NOTE! Obviously you have to change the /path/to/ the
182 correct location where you compiled the reSID-package.
183
184 5) If all went well and without errors, you now should have
185 libSIDPlay2 installed with reSID software SID emulation
186 backend.
187
188
126 Installing XMMS-SID 189 Installing XMMS-SID
127 =================== 190 ===================
128 When you have the requirements installed and working succesfully, 191 When you have the requirements installed and working succesfully,
129 you may try compiling and installation of XMMS-SID. 192 you may try compiling and installation of XMMS-SID.
130 193