xmms-sid: INSTALL annotate

annotate 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

rev	line source
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	1 This document describes overall requirements and procedure
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	2 for installation of XMMS-SID package, please read it carefully!
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	3 For more information and tips, please refer to README and FAQ.
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	4
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	5 Requirements
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	6 ============
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	7 - XMMS version 1.2.0 or later (http://www.xmms.org/)
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	8
145 e85ea6735767 Updated requirements. Matti Hamalainen <ccr@tnsp.org> parents: 123 diff changeset	9 - Gtk+ and Glib 1.2.5 or later (http://www.gtk.org/)
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	10
304 512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	11 - ANSI-C and C++-compiler. Preferably GCC along with rest of
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	12 the GNU toolchain. I have no idea whether this compiles with
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	13 any other compiler ... sorry.
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	14
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	15 - You need AT LEAST one of the following emulation libraries:
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	16
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	17 * libSIDPlay1
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	18 * libSIDPlay2
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	19
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	20 Only one emulator backend library is required, but all are
336 171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	21 supported with compile & run-time configuration. You may also
171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	22 need some supplementary libraries for each emulator library.
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	23 See below for more information.
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	24
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	25
336 171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	26 Emulator library selection hints
171b428ee806 Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 304 diff changeset	27 ================================
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	28 Some words on which emulation library you should choose to install
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	29 and use - it depends somewhat on your system and personal preferences.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	30
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	31 - libSIDPlay v1: This is the old SIDPlay v1 emulation library. Its
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	32 emulation is "frame-based" and not very accurate. The waveforms
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	33 produced are harsher and emulation of SID filter is far from
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	34 accurate.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	35
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	36 libSIDPlay v1 requires very little CPU power, it is faster and
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	37 may have fewer bugs due to being more mature software. Many
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	38 OS distributions have pre-built packages of it, not something that
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	39 can be said of libSIDPlay v2. Some people may even like the
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	40 harsher sound produced by libSIDPlay v1.
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	41
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	42 Drawbacks are: worse emulation, eventually weakening compability
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	43 as new SID-tunes/files are ripped into "RSID"-format which
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	44 libSIDPlay v1 does NOT support.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	45
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	46
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	47 - libSIDPlay v2: New, next generation modular SID-emulation framework.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	48 Along with reSID-library it produces probably most accurate emulated
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	49 representation of SID-chip available. This, however, comes at high
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	50 cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	51 selected emulation options. It is also less spread, not as many
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	52 distributions/operating systems come with pre-packaged libSIDPlay2,
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	53 so you may have to roll your own.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	54
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	55 Also the API-stability of libSIDPlay2 is not yet 100%, there may
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	56 be changes. Bugs are evident, though many of them will be fixed
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	57 eventually.
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	58
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	59
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	60 Conclusion thus is as follows: If you are using an old system with not
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	61 much spare CPU-power, choose libSIDPlay v1. On a relatively recent
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	62 system (more powerful than Pentium III 500MHz) you may wish to choose
e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	63 libSIDPlay v2, although your mileage may vary.
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	64
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	65
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	66 Where to get XMMS?
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	67 ==================
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	68 Latest version of XMMS should be available from:
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	69
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	70 http://www.xmms.org/
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	71
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	72 Please refer to XMMS documentation for information on its usage
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	73 and installation, etc. You probably have XMMS already installed,
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	74 but if you installed from a pre-built package, make sure that
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	75 you have corresponding xmms-devel -package also.
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	76
183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	77
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	78 Where to get libSIDPlay1?
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	79 =========================
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	80 Your OS distribution or some supplementary package repository
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	81 may contain libSIDPlay1 packages. Usually those should work
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	82 well, but remember to also install the corresponding -dev/-devel
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	83 package.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	84
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	85 If you can't find packages for your OS, source tarballs for
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	86 libSIDPlay1 are available at SIDPlay's homepage:
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	87
145 e85ea6735767 Updated requirements. Matti Hamalainen <ccr@tnsp.org> parents: 123 diff changeset	88 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	89
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	90 You only need libsidplay, the sidplay-base is not necessary
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	91 if you think that you do not need the commandline player.
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	92
23 469efc05e01e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 7 diff changeset	93
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	94 Where to get libSIDPlay2?
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	95 =========================
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	96 As of now, some OS distributions already include libSIDPlay2
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	97 packages, but some of those may be too old or incompatible
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	98 with XMMS-SID. Also note, that ONLY the latest CVS version
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	99 (as of 28.5.2006) of libSIDPlay2 compiles correctly with
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	100 GCC 4.x - older versions trigger a GCC4 bug, which causes
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	101 tunes to play too fast!
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	102
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	103 The fixed versions are available as source tarballs
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	104 (and RPMs for Fedora Core 3) and I highly recommend that
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	105 you use these versions. Please refer to:
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	106
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	107 http://www.tnsp.org/xmms-sid.php#download
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	108
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	109
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	110 However, the original home of libSIDPlay2 is at SourceForge:
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	111
123 9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	112 http://sidplay2.sourceforge.net/
9ab0c2fff794 Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 80 diff changeset	113
80 7047a6390b08 Updated and improved documentation Matti Hamalainen <ccr@tnsp.org> parents: 41 diff changeset	114
36 f6afce365705 Minor fix Matti Hamalainen <ccr@tnsp.org> parents: 34 diff changeset	115 Building a CVS-version
f6afce365705 Minor fix Matti Hamalainen <ccr@tnsp.org> parents: 34 diff changeset	116 ======================
f6afce365705 Minor fix Matti Hamalainen <ccr@tnsp.org> parents: 34 diff changeset	117 To build a CVS-version of XMMS-SID, you need to have latest
41 c145ff12f2d0 Various improvements Matti Hamalainen <ccr@tnsp.org> parents: 36 diff changeset	118 (STABLE) versions of following tools installed, including:
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	119
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	120 - GNU autoconf 2.56 or newer
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	121 - GNU automake 1.9 (older and newer versions MAY be incompatible!)
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	122 - GNU libtool 1.5.20 or newer
41 c145ff12f2d0 Various improvements Matti Hamalainen <ccr@tnsp.org> parents: 36 diff changeset	123 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4)
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	124
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	125 If you have all required tools installed, just run the
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	126 "bootstrap.sh"-script which generates all necessary build-files.
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	127 After successfull bootstrapping, you should be able to install
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	128 the package normally, following steps described in next chapter.
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	129
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	130
350 7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	131 Installing libSIDPlay2
7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	132 ======================
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	133 NOTICE! The upstream libSIDPlay2 has several bugs in build
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	134 scripts, which botch up building on some non-mainstream
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	135 platforms, such as NetBSD and Solaris. I personally provide
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	136 fixed versions of libSIDPlay2, reSID and reSID-builder
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	137 packages. Therefore I highly recommend that you use the
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	138 fixed versions I provide on XMMS-SID's homepage (see above).
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	139
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	140
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	141 NOTICE #2! Under Solaris you may run into a linking problem,
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	142 because of a bug in GCC's libtool, please read following
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	143 mailing list thread for more information:
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	144
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	145 http://lists.gnu.org/archive/html/libtool/2005-08/msg00021.html
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	146
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	147
350 7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	148 As the installation procedure of libSIDPlay2 is not completely
7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	149 transparent or simple, I describe here the steps how to do it
7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	150 (hopefully) in a succesful manner:
7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	151
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	152 1) Get libSIDPlay2, reSID and reSID-builder packages.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	153
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	154 2) Build reSID (you may need to invoke 'gmake' instead of 'make'):
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	155
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	156 tar -xzvf resid-0.16.2-ccr.tar.gz
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	157 cd resid-0.16.2-ccr
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	158 ./configure
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	159 make
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	160
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	161 There is no need to do "make install", just leave the
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	162 build directory intact, you will need the contents when
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	163 compiling reSID-builder below.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	164
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	165 3) Build libSIDPlay2 similarly, but this time do install.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	166 Untar the package as usual and ...
350 7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	167
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	168 ./configure
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	169 make
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	170 make install
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	171
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	172 You have to do "make install" as root.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	173
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	174 4) Build reSID-builder in similar manner, but with specific
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	175 configure parameters. As usual, untar the package and ...
350 7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	176
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	177 ./configure --with-resid=/path/to/resid-0.16.2-ccr
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	178 make
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	179 make install
350 7b6ec6ee418d PONG Matti Hamalainen <ccr@tnsp.org> parents: 336 diff changeset	180
391 3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	181 NOTE! Obviously you have to change the /path/to/ the
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	182 correct location where you compiled the reSID-package.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	183
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	184 5) If all went well and without errors, you now should have
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	185 libSIDPlay2 installed with reSID software SID emulation
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	186 backend.
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	187
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of Matti Hamalainen <ccr@tnsp.org> parents: 350 diff changeset	188
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	189 Installing XMMS-SID
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	190 ===================
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	191 When you have the requirements installed and working succesfully,
78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	192 you may try compiling and installation of XMMS-SID.
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	193
171 78e06aecad7f Updated documentation. Matti Hamalainen <ccr@tnsp.org> parents: 159 diff changeset	194 Invoke configure script (use parameter --help for help)
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	195
e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	196 $�./configure
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	197
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	198 The configure-script will print out lots of information and in
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	199 the end it tells you some of the selected build options.
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	200
304 512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	201 NOTICE! On some systems it may be necessary to force 'configure'
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	202 to use gcc instead of g++ with following syntax:
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	203
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	204 $ CC=gcc CXX=g++ ./configure
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	205
512e3ef3fc63 Document problems with gcc vs g++ Matti Hamalainen <ccr@tnsp.org> parents: 255 diff changeset	206
34 0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	207 If configure passed without errors, try compilation. (Depending
0e1189b94a7f Updated installation instructions Matti Hamalainen <ccr@tnsp.org> parents: 31 diff changeset	208 on your system, you may need to invoke 'gmake' instead of 'make'.)
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	209
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	210 $�make
e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	211
198 c7b5120c53c8 Cleanup Matti Hamalainen <ccr@tnsp.org> parents: 181 diff changeset	212 If that went OK too, then you may try installation. Again, you
c7b5120c53c8 Cleanup Matti Hamalainen <ccr@tnsp.org> parents: 181 diff changeset	213 may need to invoke 'gmake' instead of 'make'. Install globally
c7b5120c53c8 Cleanup Matti Hamalainen <ccr@tnsp.org> parents: 181 diff changeset	214 to whole system (as root):
7 e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	215
e5c49367b899 Updated to 0.8 Matti Hamalainen <ccr@tnsp.org> parents: 1 diff changeset	216 # make install
1 183e7cbc1036 Initial revision Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	217
255 d8f088079384 Tell user that some datafiles are not installed when using 'install-user' Matti Hamalainen <ccr@tnsp.org> parents: 251 diff changeset	218 or install for current user only: (Please notice that some data
d8f088079384 Tell user that some datafiles are not installed when using 'install-user' Matti Hamalainen <ccr@tnsp.org> parents: 251 diff changeset	219 files are not installed when intalling for user only)
181 be1cf864f28e Added install-user and uninstall-user targets which install to current Matti Hamalainen <ccr@tnsp.org> parents: 171 diff changeset	220
be1cf864f28e Added install-user and uninstall-user targets which install to current Matti Hamalainen <ccr@tnsp.org> parents: 171 diff changeset	221 $ make install-user
be1cf864f28e Added install-user and uninstall-user targets which install to current Matti Hamalainen <ccr@tnsp.org> parents: 171 diff changeset	222
249 b02705a9b2d6 Duh. Matti Hamalainen <ccr@tnsp.org> parents: 210 diff changeset	223 Assuming all went correctly, XMMS-SID is now installed. You should
b02705a9b2d6 Duh. Matti Hamalainen <ccr@tnsp.org> parents: 210 diff changeset	224 now start or re-start XMMS and configure XMMS-SID's various options.
199 6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	225
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	226
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	227 Post-installation configuration
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	228 ===============================
251 e9ea4ce4c697 Muchly improved documentation and installation instructions. Matti Hamalainen <ccr@tnsp.org> parents: 249 diff changeset	229 To gain full advantage of using XMMS-SID, you need to configure it.
199 6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	230 XMMS-SID can be configured just like any other XMMS plugin, in XMMS
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	231 do as follows:
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	232
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	233 -> Press <ctrl+p>
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	234 -> Select "Audio I/O Plugins"-tab
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	235 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	236 -> Click "Configure"
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	237
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	238 Please refer to README for more information about configuration.
6117c326cc3e Updated documentation Matti Hamalainen <ccr@tnsp.org> parents: 198 diff changeset	239

Mercurial > hg > xmms-sid

annotate INSTALL @ 391:3cc7455360ad