annotate INSTALL @ 80:7047a6390b08

Updated and improved documentation
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 03 Oct 2003 03:14:00 +0000
parents c145ff12f2d0
children 9ab0c2fff794
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 Requirements
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 ============
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 - 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
4
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
5 - 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
6
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
7 - C and C++-compiler. Preferably gcc and g++, I have
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
8 no idea whether this compiles with any other
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
9 compilers ... sorry.
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
10
23
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
11 - You need either one or both of the following:
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
12 * libsidplay1
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
13 * libsidplay2
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
14
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
15 Only v1 or v2 is required and you can only compile in support
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
16 for either one, but not both! See below for more information
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
17 about them.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
19
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20 Where to get XMMS?
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21 ==================
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 Latest version of XMMS should be available from
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24 http://www.xmms.org/
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 Please refer to XMMS documentation for information
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 on it's usage and installation (etc).
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
30 Where to get those emulator libraries?
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
31 ======================================
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
32
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
33 * libSIDPlay1 is available at SIDPlay's homepage:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
35 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
37 You only need libsidplay, the sidplay-base is not necessary
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
38 if you are sure that you don't need the commandline player.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
39
23
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
40
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
41 * libSIDPlay2 is available at SourceForge:
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
42
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
43 http://sidplay2.sourceforge.net/
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
44
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
45 You need the "sidplay-libs-2.1.0" package! Earlier versions
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
46 WILL NOT WORK! Later versions MAY work, but it is not really
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
47 guaranteed.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
48
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
49
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
50 * libNanoSID is available from LolOLOlo's pages:
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
51
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
52 http://www.sid6581.org/NanoSID/
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54
36
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
55 Building a CVS-version
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
56 ======================
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
57 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
58 (STABLE) versions of following tools installed, including:
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
59
41
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
60 - GNU autoconf 2.56 or later
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
61 - GNU automake 1.7 or later
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
62 - GNU libtool 1.4.3 or later
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
63 - 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
64
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
65 If you have all required tools installed, just run the
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
66 "bootstrap.sh"-script which generates all necessary
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
67 build-files. After successfull bootstrapping, you can
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
68 continue to install the package normally.
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
69
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
70
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
71 Installing XMMS-SID
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
72 ===================
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
73 When you have the requirements installed and working
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
74 succesfully, you can try compiling XMMS-SID.
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
75
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
76 Invoke configure-script (use parameter --help for help)
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
77
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
78 $ ./configure
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
79
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
80 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
81 use by specifying either --with-sidplay1 or --with-sidplay2
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
82 options. If none are specified, configure will use the first
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
83 one found.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
84
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
85 The configure-script will print out lots of information and in
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
86 the end it tells you some of the selected build options.
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
87
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
88 If configure passed without errors, try compilation. (Depending
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
89 on your system, you may need to invoke 'gmake' instead of 'make'.)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
90
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
91 $ make
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
92
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
93 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
94 you are installing globally for the system). Again, you may need
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
95 to invoke 'gmake' instead of 'make'.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
96
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
97 # make install
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
98
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
99 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
100 and go play with your shiny new XMMS-SID-plugin! :-)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
101