annotate INSTALL @ 1016:0fee394985f2 default tip

Added xmms.m4
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 09 Jan 2016 19:05:29 +0200
parents d8c1c1c5f609
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 ============
738
73608042aec8 Update version requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 680
diff changeset
7 - Last version of XMMS1, version 1.2.11.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
8
738
73608042aec8 Update version requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 680
diff changeset
9 - Last versions of Gtk+1 and Glib1: 1.2.10 (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
995
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
18 * libSIDPlay2 or libSIDPlayFP (mutually exclusive)
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
416
eff5ea454bae Changed wording.
Matti Hamalainen <ccr@tnsp.org>
parents: 391
diff changeset
31 - libSIDPlay v1: This is the old and original emulation library. Its
251
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
987
bafb3f102e91 Update some of the installation information.
Matti Hamalainen <ccr@tnsp.org>
parents: 829
diff changeset
36 libSIDPlay v1 requires very little CPU power, it will work even
bafb3f102e91 Update some of the installation information.
Matti Hamalainen <ccr@tnsp.org>
parents: 829
diff changeset
37 on very slow devices. Many OS distributions have pre-built packages
bafb3f102e91 Update some of the installation information.
Matti Hamalainen <ccr@tnsp.org>
parents: 829
diff changeset
38 of it, not something that can be said of libSIDPlay v2, even less
995
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
39 libSIDPlayFP. Some people may even like theharsher sound produced
987
bafb3f102e91 Update some of the installation information.
Matti Hamalainen <ccr@tnsp.org>
parents: 829
diff changeset
40 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
741
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
47 - libSIDPlay2+reSID or HardSID: A much more accurate emulation
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
48 framework. Unfortunately the original fork has mostly stalled,
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
49 though works. Much heavier CPU-load compared to libSIDPlay1,
995
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
50 but not as heavy as libSIDPlayFP.
741
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
51
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 249
diff changeset
52
995
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
53 - libSIDPlayFP: Fork of libSIDPlay2. New, next generation modular
741
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
54 SID-emulation framework. Along with reSID-library it produces
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
55 probably most accurate software-emulated representation of
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
56 SID-chip available. This, however, comes at high cost:
995
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
57 libSIDPlayFP tends to eat CPU like popcorn.
741
8c80b3c5c053 Update documentation concerning libSIDPlay-FP etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 739
diff changeset
58
1015
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
59
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
60 Conclusion thus is as follows: If you are using a VERY old system without
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
61 much spare CPU-power, choose libSIDPlay v1. On any system that is not
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
62 older than a decade, you probably want libSIDPlayFP.
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 249
diff changeset
63
1015
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
64 There isn't any reason to choose libSIDPlay v2 over "FP" nowadays,
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
65 unless you are somehow stuck with a system that can't handle FP.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
66
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
67
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
68 Where to get XMMS?
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 Latest version of XMMS should be available from:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
71
1001
fe9e84de906b Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 995
diff changeset
72 http://legacy.xmms2.org/
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
73
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
74 Please refer to XMMS documentation for information on its usage
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
75 and installation, etc. You probably have XMMS already installed,
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
76 but if you installed from a pre-built package, make sure that
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
77 you have corresponding xmms-devel -package also.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
78
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
79
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
80 Where to get libSIDPlay1?
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
81 =========================
679
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
82 Typically your OS distribution and/or some supplementary package
559
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents: 483
diff changeset
83 repository may contain libSIDPlay1 packages. Usually those work
391
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents: 350
diff changeset
84 well, but remember to also install the corresponding -dev/-devel
559
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents: 483
diff changeset
85 package so that XMMS-SID can be compiled.
391
3cc7455360ad Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents: 350
diff changeset
86
813
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
87 For example, in Debian (or Ubuntu):
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
88
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
89 $ apt-get install libsidplay1-dev
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
90
23
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
91
995
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
92 Where to get libSIDPlayFP?
cfc879a562c3 s/libSIDPlay-FP/libSIDPlayFP/g.
Matti Hamalainen <ccr@tnsp.org>
parents: 987
diff changeset
93 ==========================
813
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
94
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
95 $ apt-get install libsidplayfp-dev
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
96
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
97 Or head to:
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
98
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
99 http://sourceforge.net/projects/sidplay-residfp/
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
100
1014
7527468689e7 Update libsidplayfp compatibility note again.
Matti Hamalainen <ccr@tnsp.org>
parents: 1011
diff changeset
101 Versions 0.3.8, 1.0.1 - 1.5.x should be compatible with XMMS-SID.
1001
fe9e84de906b Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 995
diff changeset
102 Earlier and later ones might not, there is no guarantee.
813
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
103
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
104
1015
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
105 Where to get and how to install libSIDPlay2?
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
106 ============================================
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
107 You might have it in your $OS_DISTRIBUTION of preference. For example
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
108 Debian should have a compatible set of packages available, try:
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
109
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
110 $ apt-get install libsidplay2-dev libresid-builder-dev
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
111
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
112
679
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
113 Building a Mercurial-version
680
f5b818a57d0c Few cosmetic fixes and clarifications.
Matti Hamalainen <ccr@tnsp.org>
parents: 679
diff changeset
114 ============================
679
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
115 To build a version of XMMS-SID from Mercurial repository,
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
116 you need to have following tools installed:
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
117
829
2531396c2718 Bump up autoconf version requirement.
Matti Hamalainen <ccr@tnsp.org>
parents: 813
diff changeset
118 - GNU autoconf 2.65 or newer
738
73608042aec8 Update version requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 680
diff changeset
119 - GNU automake 1.11 or newer
813
b8b9da405e8c Update documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 741
diff changeset
120 - GNU libtool 2.4.2 or newer
41
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
121 - 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
122
679
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
123 Source repository can be fetched via Mercurial using:
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
124
739
bd12199a9a84 Update Mercurial repository URL.
Matti Hamalainen <ccr@tnsp.org>
parents: 738
diff changeset
125 $ hg clone http://tnsp.org/hg/xmms-sid xmms-sid-hg
679
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
126
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
127 If you have all required tools installed, you can then just
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
128
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
129 $ cd xmms-sid-hg
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
130 $ hg update tip
680
f5b818a57d0c Few cosmetic fixes and clarifications.
Matti Hamalainen <ccr@tnsp.org>
parents: 679
diff changeset
131 $ ./bootstrap.sh
679
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
132
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
133 Running bootstrap.sh should generate all necessary build-files,
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
134 assuming everything went well. After successfull bootstrapping,
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
135 you should be able to compile the package normally, following
36a2d95e4644 Updated documentation, added Mercurial instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 559
diff changeset
136 steps described below.
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
137
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
138
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
139 Installing XMMS-SID
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
140 ===================
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
141 When you have the requirements installed and working succesfully,
559
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents: 483
diff changeset
142 you may try compilation and installation of XMMS-SID.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
143
559
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents: 483
diff changeset
144 Invoke configure script (use 'configure --help' for help)
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
145
738
73608042aec8 Update version requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 680
diff changeset
146 $ ./configure
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
147
559
80f7cafcda0a Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents: 483
diff changeset
148 The configure script will print out lots of information and in
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
149 the end it tells you some of the selected build options.
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
150
304
512e3ef3fc63 Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents: 255
diff changeset
151 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
152 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
153
512e3ef3fc63 Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents: 255
diff changeset
154 $ CC=gcc CXX=g++ ./configure
512e3ef3fc63 Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents: 255
diff changeset
155
512e3ef3fc63 Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents: 255
diff changeset
156
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
157 If configure passed without errors, try compilation. (Depending
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
158 on your system, you may need to invoke 'gmake' instead of 'make'.)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
159
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
160 $ make
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
161
198
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
162 If that went OK too, then you may try installation. Again, you
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
163 may need to invoke 'gmake' instead of 'make'. Install globally
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
164 to whole system (as root):
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
165
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
166 # make install
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
167
483
3f58a06bc9df Typofixes in instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 416
diff changeset
168 or install for current user only: (NOTICE! Locales and data files
3f58a06bc9df Typofixes in instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 416
diff changeset
169 will not be installed with this method)
181
be1cf864f28e Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents: 171
diff changeset
170
be1cf864f28e Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents: 171
diff changeset
171 $ make install-user
be1cf864f28e Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents: 171
diff changeset
172
249
Matti Hamalainen <ccr@tnsp.org>
parents: 210
diff changeset
173 Assuming all went correctly, XMMS-SID is now installed. You should
Matti Hamalainen <ccr@tnsp.org>
parents: 210
diff changeset
174 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
175
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
176
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
177 Post-installation configuration
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
178 ===============================
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 249
diff changeset
179 To gain full advantage of using XMMS-SID, you need to configure it.
1015
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
180 When running for the first time, XMMS-SID will show its configuration
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
181 dialog automatically.
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
182
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
183 Afterwards it can be configured just like any other XMMS plugin,
d8c1c1c5f609 Update installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 1014
diff changeset
184 in XMMS do as follows:
199
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
185
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
186 -> Press <ctrl+p>
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
187 -> Select "Audio I/O Plugins"-tab
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
188 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
189 -> Click "Configure"
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
190
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
191 Please refer to README for more information about configuration.
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
192