annotate README @ 8:c54fe2f77030

made build process more robust
author Robert McIntyre <rlm@mit.edu>
date Thu, 27 Oct 2011 02:40:54 -0700
parents f9476ff7637e
children a988ea53d982
rev   line source
rlm@0 1 Source Install
rlm@0 2 ==============
rlm@0 3
rlm@0 4 To install OpenAL Soft, use your favorite shell to go into the build/
rlm@0 5 directory, and run:
rlm@0 6
rlm@0 7 cmake ..
rlm@0 8
rlm@0 9 Assuming configuration went well, you can then build it, typically using GNU
rlm@0 10 Make (KDevelop, MSVC, and others are possible depending on your system setup
rlm@0 11 and CMake configuration).
rlm@0 12
rlm@0 13 Please Note: Double check that the appropriate backends were detected. Often,
rlm@0 14 complaints of no sound, crashing, and missing devices can be solved by making
rlm@0 15 sure the correct backends are being used. CMake's output will identify which
rlm@0 16 backends were enabled.
rlm@0 17
rlm@0 18 For most systems, you will likely want to make sure ALSA, OSS, and PulseAudio
rlm@0 19 were detected (if your target system uses them). For Windows, make sure
rlm@0 20 DirectSound was detected.
rlm@0 21
rlm@0 22
rlm@0 23 Utilities
rlm@0 24 =========
rlm@0 25
rlm@0 26 The source package comes with an informational utility, openal-info, and is
rlm@0 27 built by default. It prints out information provided by the ALC and AL sub-
rlm@0 28 systems, including discovered devices, version information, and extensions.
rlm@0 29
rlm@0 30
rlm@0 31 Configuration
rlm@0 32 =============
rlm@0 33
rlm@0 34 OpenAL Soft can be configured on a per-user and per-system basis. This allows
rlm@0 35 users and sysadmins to control information provided to applications, as well
rlm@0 36 as application-agnostic behavior of the library. See alsoftrc.sample for
rlm@0 37 available settings.
rlm@0 38
rlm@0 39
rlm@0 40 Acknowledgements
rlm@0 41 ================
rlm@0 42
rlm@0 43 Special thanks go to:
rlm@0 44
rlm@0 45 Creative Labs for the original source code this is based off of.
rlm@0 46
rlm@0 47 Christopher Fitzgerald for the current reverb effect implementation, and
rlm@0 48 helping with the low-pass filter.
rlm@0 49
rlm@0 50 Christian Borss for the 3D panning code the current implementation is heavilly
rlm@0 51 based on.
rlm@0 52
rlm@0 53 Ben Davis for the idea behind the current click-removal code.