Mercurial > hg > xmms-sid
annotate INSTALL @ 255:d8f088079384
Tell user that some datafiles are not installed when using 'install-user'
make target.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Tue, 21 Dec 2004 21:22:00 +0000 |
parents | e9ea4ce4c697 |
children | 512e3ef3fc63 |
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 | 5 Requirements |
6 ============ | |
7 - XMMS version 1.2.0 or later (http://www.xmms.org/) | |
7 | 8 |
145 | 9 - Gtk+ and Glib 1.2.5 or later (http://www.gtk.org/) |
7 | 10 |
171 | 11 - C and C++-compiler. Preferably GCC along with rest of the |
12 GNU toolchain. I have no idea whether this compiles with | |
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 | 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 | 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 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
21 supported with run-time configuration. You may also need |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
22 some supplementary libraries for each emulator library. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
23 See below for more information. |
171 | 24 |
25 | |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
26 Emulator library selection recommendations |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
27 ========================================== |
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 | 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 | 64 |
65 | |
66 Where to get XMMS? | |
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 | 69 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
70 http://www.xmms.org/ |
1 | 71 |
171 | 72 Please refer to XMMS documentation for information on its usage |
73 and installation, etc. You probably have XMMS already installed, | |
74 but if you installed from a pre-built package, make sure that | |
75 you have corresponding xmms-devel -package also. | |
1 | 76 |
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 ========================= |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
80 libSIDPlay1 is available at SIDPlay's homepage: |
1 | 81 |
145 | 82 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html |
1 | 83 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
84 You only need libsidplay, the sidplay-base is not necessary |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
85 if you are sure that you don't need the commandline player. |
1 | 86 |
23 | 87 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
88 Where to get libSIDPlay2? |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
89 ========================= |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
90 libSIDPlay2 is available at SourceForge: |
7 | 91 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
92 http://sidplay2.sourceforge.net/ |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
93 |
171 | 94 You need the "sidplay-libs-2.1.0" package! Earlier versions WILL NOT |
95 WORK! Later versions MAY work, but I can't really guarantee that. | |
7 | 96 |
80
7047a6390b08
Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents:
41
diff
changeset
|
97 |
36 | 98 Building a CVS-version |
99 ====================== | |
100 To build a CVS-version of XMMS-SID, you need to have latest | |
41 | 101 (STABLE) versions of following tools installed, including: |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
102 |
171 | 103 - GNU autoconf 2.56 or newer |
104 - GNU automake 1.7 (older and newer versions MAY be incompatible!) | |
210 | 105 - GNU libtool 1.5.6 or newer |
41 | 106 - 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
|
107 |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
108 If you have all required tools installed, just run the |
171 | 109 "bootstrap.sh"-script which generates all necessary build-files. |
110 After successfull bootstrapping, you should be able to install | |
111 the package normally, following steps described in next chapter. | |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
112 |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
113 |
7 | 114 Installing XMMS-SID |
1 | 115 =================== |
171 | 116 When you have the requirements installed and working succesfully, |
117 you may try compiling and installation of XMMS-SID. | |
7 | 118 |
171 | 119 Invoke configure script (use parameter --help for help) |
7 | 120 |
121 $ ./configure | |
1 | 122 |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
123 The configure-script will print out lots of information and in |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
124 the end it tells you some of the selected build options. |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
125 |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
126 If configure passed without errors, try compilation. (Depending |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
127 on your system, you may need to invoke 'gmake' instead of 'make'.) |
1 | 128 |
7 | 129 $ make |
130 | |
198 | 131 If that went OK too, then you may try installation. Again, you |
132 may need to invoke 'gmake' instead of 'make'. Install globally | |
133 to whole system (as root): | |
7 | 134 |
135 # make install | |
1 | 136 |
255
d8f088079384
Tell user that some datafiles are not installed when using 'install-user'
Matti Hamalainen <ccr@tnsp.org>
parents:
251
diff
changeset
|
137 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
|
138 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
|
139 |
be1cf864f28e
Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents:
171
diff
changeset
|
140 $ make install-user |
be1cf864f28e
Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents:
171
diff
changeset
|
141 |
249 | 142 Assuming all went correctly, XMMS-SID is now installed. You should |
143 now start or re-start XMMS and configure XMMS-SID's various options. | |
199 | 144 |
145 | |
146 Post-installation configuration | |
147 =============================== | |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
148 To gain full advantage of using XMMS-SID, you need to configure it. |
199 | 149 XMMS-SID can be configured just like any other XMMS plugin, in XMMS |
150 do as follows: | |
151 | |
152 -> Press <ctrl+p> | |
153 -> Select "Audio I/O Plugins"-tab | |
154 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list | |
155 -> Click "Configure" | |
156 | |
157 Please refer to README for more information about configuration. | |
158 |