1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Oct 25 13:02:31 2011 -0700
     1.3 @@ -0,0 +1,53 @@
     1.4 +Source Install
     1.5 +==============
     1.6 +
     1.7 +To install OpenAL Soft, use your favorite shell to go into the build/
     1.8 +directory, and run:
     1.9 +
    1.10 +cmake ..
    1.11 +
    1.12 +Assuming configuration went well, you can then build it, typically using GNU
    1.13 +Make (KDevelop, MSVC, and others are possible depending on your system setup
    1.14 +and CMake configuration).
    1.15 +
    1.16 +Please Note: Double check that the appropriate backends were detected. Often,
    1.17 +complaints of no sound, crashing, and missing devices can be solved by making
    1.18 +sure the correct backends are being used. CMake's output will identify which
    1.19 +backends were enabled.
    1.20 +
    1.21 +For most systems, you will likely want to make sure ALSA, OSS, and PulseAudio
    1.22 +were detected (if your target system uses them). For Windows, make sure
    1.23 +DirectSound was detected.
    1.24 +
    1.25 +
    1.26 +Utilities
    1.27 +=========
    1.28 +
    1.29 +The source package comes with an informational utility, openal-info, and is
    1.30 +built by default. It prints out information provided by the ALC and AL sub-
    1.31 +systems, including discovered devices, version information, and extensions.
    1.32 +
    1.33 +
    1.34 +Configuration
    1.35 +=============
    1.36 +
    1.37 +OpenAL Soft can be configured on a per-user and per-system basis. This allows
    1.38 +users and sysadmins to control information provided to applications, as well
    1.39 +as application-agnostic behavior of the library. See alsoftrc.sample for
    1.40 +available settings.
    1.41 +
    1.42 +
    1.43 +Acknowledgements
    1.44 +================
    1.45 +
    1.46 +Special thanks go to:
    1.47 +
    1.48 +Creative Labs for the original source code this is based off of.
    1.49 +
    1.50 +Christopher Fitzgerald for the current reverb effect implementation, and
    1.51 +helping with the low-pass filter.
    1.52 +
    1.53 +Christian Borss for the 3D panning code the current implementation is heavilly
    1.54 +based on.
    1.55 +
    1.56 +Ben Davis for the idea behind the current click-removal code.