annotate INSTALL @ 281:ad4c8f34136a

Minor formatting updates.
author Ryan C. Gordon <icculus@icculus.org>
date Thu, 14 Mar 2002 21:12:46 +0000
parents abe472572e38
children 4a2cd7d4aa06
rev   line source
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
1 Building is pretty easy. Please read README, too, as it duplicates and
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
2 expands upon much of this information.
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
4
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5 ALL PLATFORMS:
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
6
184
47cc2de2ae36 Changed reference to "LICENSE" file to "COPYING".
Ryan C. Gordon <icculus@icculus.org>
parents: 140
diff changeset
7 Please understand your rights and mine: read the text file COPYING in the root
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
8 of the source tree. If you can't abide by it, delete this source tree now.
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
9
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
10 The best documentation for the SDL_sound API is SDL_sound.h. It is VERY
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
11 heavily commented, and makes an excellent, in-depth reference to all the
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
12 functions.
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
13
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
15 Unix:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
16 (If you pulled the source from CVS), run ./bootstrap
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
17
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
18 run ./configure --help, and see if there's any options you need. Rerun
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
19 configure with those options. If this is confusing to you, just run
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
20 ./configure with no options: the defaults are generally decent, and
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
21 configure is usually smart enough to figure out what's best..
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
22
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
23 If configuration succeeded, run "make".
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
24
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
25 Run "make install" as root to install the library for use on your system.
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
26
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
27 This should work for most Unix-style systems, including Linux, *BSD, BeOS, and
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
28 MacOS X. Reports of success and failure are welcome.
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
29
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
30
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
31 MacOS 9 users:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
32 Included with the source is CWProject.sit, which contains project files for
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
33 CodeWarrior 5.0 and later.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
34
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
35
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
36 MacOS X command line tools:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
37 You can use the "UNIX" instructions above if you like the command line tools.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
38
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
39
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
40 MacOS X Project Builder:
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
41 If you prefer to use Project Builder, download this file:
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
42 http://icculus.org/SDL_sound/downloads/PBProjects.tar.gz
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
43 ...and unpack it in the root of the SDL_sound folder. This archive contains
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
44 several external libraries you would have to download/install manually if you
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
45 used the command line tools (these libraries are for extra decoders, and are
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
46 NOT required for SDL_sound to function...however, without them, the number of
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
47 sound formats you can decode is reduced.)
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
48
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
49
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
50 BeOS:
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
51 You can use the "UNIX" instructions above, too.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
52
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
53
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
54 Win32 Visual C:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
55 For Visual C, download
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
56 http://icculus.org/SDL_sound/downloads/sdl_sound_visualc_srcs.zip
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
57 ...and unzip it somewhere. This zipfile has a complete copy of the
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
58 SDL_sound sources, Visual C project files, and several external libraries,
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
59 too. This zip is everything you should need, and you can scrap this copy of
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
60 the source.
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
61
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
62
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
63 Win32 Cygwin:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
64 Cygwin users can try their luck with the Unix build instructions in this
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
65 tarball instead.
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
66
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
67
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
68 If building is successful, there will be a shared library and a binary
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
69 called "playsound".
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
70
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
71
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
72
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
73 OTHER PLATFORMS:
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
74
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
75 Send me patches, and instructions, and I'll list them here. Consider
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
76 joining the SDL_sound mailing list. Details are at:
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
77 http://icculus.org/SDL_sound/
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
78
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
79 --ryan. (icculus@clutteredmind.org)
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
80
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
81