annotate INSTALL @ 394:b495d05a88b3

Updated.
author Ryan C. Gordon <icculus@icculus.org>
date Thu, 11 Jul 2002 04:33:17 +0000
parents 7e49f4901ceb
children 41412aa092d1
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
379
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
12 functions. The official API reference is generated from this file with
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
13 a program called "Doxygen" (http://www.doxygen.org/)
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
15
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
16 Unix:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
17 (If you pulled the source from CVS), run ./bootstrap
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
18
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
19 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
20 configure with those options. If this is confusing to you, just run
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
21 ./configure with no options: the defaults are generally decent, and
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
22 configure is usually smart enough to figure out what's best..
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
23
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
24 If configuration succeeded, run "make".
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
25
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
26 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
27
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
28 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
29 MacOS X. Reports of success and failure are welcome.
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
30
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
31
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
32 MacOS 9 users:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
33 Included with the source is CWProject.sit, which contains project files for
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
34 CodeWarrior 5.0 and later.
248
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
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
37 MacOS X command line tools:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
38 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
39
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
40
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
41 MacOS X Project Builder:
319
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
42 If you prefer to use Project Builder, use the project files included with
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
43 this source: PBProjects.tar.gz...unpack it in the root of the SDL_sound
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
44 folder. This archive contains several external libraries you would have
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
45 to download/install manually if you used the command line tools (these
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
46 libraries are for extra decoders, and are NOT required for SDL_sound to
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
47 function...however, without them, the number of sound formats you can
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
48 decode is reduced.)
264
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
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
51 BeOS:
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
52 You can use the "UNIX" instructions above, too.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
53
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
54
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
55 Win32 Visual C:
319
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
56 For Visual C, use:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
57 http://icculus.org/SDL_sound/downloads/sdl_sound_visualc_srcs.zip
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
58 ...and unzip it somewhere. This zipfile has a complete copy of the
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
59 SDL_sound sources, Visual C project files, and several external libraries,
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
60 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
61 the source.
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
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
64 Win32 Cygwin:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
65 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
66 tarball instead.
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
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
69 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
70 called "playsound".
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
71
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
72
379
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
73 Windows CE (Microsoft PocketPC):
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
74 You'll need Microsoft's PocketPC development environment, and this zipfile:
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
75 http://icculus.org/SDL_sound/downloads/SDL_soundCE.zip
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
76
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
77 Unzip that into the root of this source tree. The new "wce" directory has
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
78 project files, and the source to some of the external decoders is included.
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
79 Note that not all of the decoders are supported on PocketPC (but please, do
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
80 send us patches if you get them working!)
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
81
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
82
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
83 OTHER PLATFORMS:
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
84
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
85 Send me patches, and instructions, and I'll list them here. Consider
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
86 joining the SDL_sound mailing list. Details are at:
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
87 http://icculus.org/SDL_sound/
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
88
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
89 --ryan. (icculus@clutteredmind.org)
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
90
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
91