annotate INSTALL @ 123:9ab0c2fff794

Updated installation instructions
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 14 Jan 2004 03:55:02 +0000
parents 7047a6390b08
children e85ea6735767
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!
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
3
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
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
9 - Gtk+ and Glib 1.2.8 or later (http://www.gtk.org/)
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
10
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
11 - C and C++-compiler. Preferably gcc and g++, I have no idea
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
12 whether this compiles with any other compilers ... sorry.
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
13
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
14 - You need AT LEAST one emulation library:
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
15
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
16 * libSIDPlay1
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
17 * libSIDPlay2
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
18 * NanoSID
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
19
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
20 Only one is required, but all are supported. You may also
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
21 need some supplementary libraries, that are required by
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
22 the emulator library. See below for more information.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25 Where to get XMMS?
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 ==================
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
27 Latest version of XMMS should be available from:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
29 http://www.xmms.org/
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 Please refer to XMMS documentation for information
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
32 on it's usage and installation (etc).
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
35 Where to get libSIDPlay1?
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
36 =========================
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
37 libSIDPlay1 is available at SIDPlay's homepage:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
38
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
39 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
40
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
41 You only need libsidplay, the sidplay-base is not necessary
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
42 if you are sure that you don't need the commandline player.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
43
23
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
44
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
45 Where to get libSIDPlay2?
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
46 =========================
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
47 libSIDPlay2 is available at SourceForge:
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
48
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
49 http://sidplay2.sourceforge.net/
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
50
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
51 You need the "sidplay-libs-2.1.0" package! Earlier versions
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
52 WILL NOT WORK! Later versions MAY work, but I can't really
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
53 guarantee that.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
54
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
55
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
56 Where to get NanoSID?
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
57 =====================
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
58 libNanoSID is available from LolOLOlo's pages:
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
59
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
60 http://www.sid6581.org/NanoSID/
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
61
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
62 The configure looks the "libNanoSID.a" and "libNanoSID.h"
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
63 from the standard locations, but you can also specify them
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
64 yourself if you don't wish to "install" them.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
65
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
66
36
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
67 Building a CVS-version
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
68 ======================
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
69 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
70 (STABLE) versions of following tools installed, including:
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
71
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
72 - GNU autoconf 2.57 or later
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
73 - GNU automake 1.7.6 or later
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
74 - GNU libtool 1.5 or later
41
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
75 - 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
76
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
77 If you have all required tools installed, just run the
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
78 "bootstrap.sh"-script which generates all necessary
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
79 build-files. After successfull bootstrapping, you can
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
80 continue to install the package normally.
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
81
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
82
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
83 Installing XMMS-SID
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
84 ===================
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
85 When you have the requirements installed and working
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
86 succesfully, you can try compiling XMMS-SID.
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
87
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
88 Invoke configure-script (use parameter --help for help)
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
89
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
90 $ ./configure
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
91
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
92 You may need to select which version of libSIDPlay you want to
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
93 use by specifying either --with-sidplay1 or --with-sidplay2
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
94 options. If none are specified, configure will use the first
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
95 one found.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
96
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
97 The configure-script will print out lots of information and in
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
98 the end it tells you some of the selected build options.
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
99
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
100 If configure passed without errors, try compilation. (Depending
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
101 on your system, you may need to invoke 'gmake' instead of 'make'.)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
102
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
103 $ make
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
104
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
105 If that went OK too, then you may try installation (as root, if
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
106 you are installing globally for the system). Again, you may need
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
107 to invoke 'gmake' instead of 'make'.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
108
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
109 # make install
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
110
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
111 If everything went as supposed, you may now try (re)starting XMMS
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
112 and go play with your shiny new XMMS-SID-plugin! :-)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
113