Mercurial > SDL_sound_CoreAudio

comparison INSTALL.txt @ 551:668dd6675b7f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Renamed a bunch of FILENAME to FILENAME.txt
author Ryan C. Gordon <icculus@icculus.org>
date Tue, 09 Sep 2008 16:26:24 -0400
parents INSTALL@2df1f5c62d38
children
comparison
equal deleted inserted replaced
550:fd3f109c5caf 551:668dd6675b7f
1 Building is pretty easy. Please read README, too, as it duplicates and
2 expands upon much of this information.
3
4
5 ALL PLATFORMS:
6
7 Please understand your rights and mine: read the text file COPYING in the root
8 of the source tree. If you can't abide by it, delete this source tree now.
9
10 The best documentation for the SDL_sound API is SDL_sound.h. It is VERY
11 heavily commented, and makes an excellent, in-depth reference to all the
12 functions. The official API reference is generated from this file with
13 a program called "Doxygen" (http://www.doxygen.org/)
14
15
16 Borland C++ Builder for Linux (Kylix 3):
17 Unzip the "borland.zip" file in the root of the source tree and use the
18 project files in the newly-created Borland/k3 directory. Makefiles for the
19 command line compiler are in Borland/freebcc ...
20
21
22 Unix:
23 (If you pulled the source from CVS), run ./bootstrap
24
25 run ./configure --help, and see if there's any options you need. Rerun
26 configure with those options. If this is confusing to you, just run
27 ./configure with no options: the defaults are generally decent, and
28 configure is usually smart enough to figure out what's best..
29
30 If configuration succeeded, run "make".
31
32 Run "make install" as root to install the library for use on your system.
33
34 This should work for most Unix-style systems, including Linux, *BSD, BeOS, and
35 MacOS X. Reports of success and failure are welcome.
36
37
38 MacOS 9 users:
39 Included with the source is CWProject.sit, which contains project files for
40 CodeWarrior 5.0 and later.
41
42
43 MacOS X command line tools:
44 You can use the "UNIX" instructions above if you like the command line tools.
45
46
47 MacOS X Project Builder:
48 If you prefer to use Project Builder, use the project files included with
49 this source: PBProjects.tar.gz...unpack it in the root of the SDL_sound
50 folder. This archive contains several external libraries you would have
51 to download/install manually if you used the command line tools (these
52 libraries are for extra decoders, and are NOT required for SDL_sound to
53 function...however, without them, the number of sound formats you can
54 decode is reduced.)
55
56
57 BeOS:
58 You can use the "UNIX" instructions above, too.
59
60
61 Win32 Visual C:
62 For Visual C, use:
63 http://icculus.org/SDL_sound/downloads/sdl_sound_visualc_srcs.zip
64 ...and unzip it somewhere. This zipfile has a complete copy of the
65 SDL_sound sources, Visual C project files, and several external libraries,
66 too. This zip is everything you should need, and you can scrap this copy of
67 the source.
68
69
70 Win32 Cygwin:
71 Cygwin users can try their luck with the Unix build instructions in this
72 tarball instead.
73
74
75 Win32 Borland C++ Builder 6:
76 Unzip the "borland.zip" file in the root of the source tree and use the
77 project files in the newly-created Borland/bcb6 directory. Makefiles for the
78 command line compiler are in Borland/freebcc ... these are unmaintained, and
79 you will need to go find the external libraries you want to use (those that
80 wish to maintain these project files should contact me).
81
82
83 If building is successful, there will be a shared library and a binary
84 called "playsound".
85
86
87 Windows CE (Microsoft PocketPC):
88 You'll need Microsoft's PocketPC development environment, and this zipfile:
89 http://icculus.org/SDL_sound/downloads/SDL_soundCE.zip
90
91 Unzip that into the root of this source tree. The new "wce" directory has
92 project files, and the source to some of the external decoders is included.
93 Note that not all of the decoders are supported on PocketPC (but please, do
94 send us patches if you get them working!)
95
96
97 OTHER PLATFORMS:
98
99 Send me patches, and instructions, and I'll list them here. Consider
100 joining the SDL_sound mailing list. Details are at:
101 http://icculus.org/SDL_sound/
102
103 --ryan. (icculus@icculus.org)
104
105