diff options
author | Arthur Brainville <[email protected]> | 2018-01-27 23:16:36 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2018-01-27 23:16:36 +0100 |
commit | c969dad6c25bdce58e70e71eac92c4ba6f9ccf30 (patch) | |
tree | d6487141e8ab2f3ec13912c957b5b985b814883a /README | |
parent | 9613b4bfe24cbefba0f4c9c738ebd30d4b116970 (diff) |
Reformat README for a nicer display on github
Diffstat (limited to 'README')
-rw-r--r-- | README | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/README b/README deleted file mode 100644 index a0178ae5..00000000 --- a/README +++ /dev/null @@ -1,55 +0,0 @@ -Source Install -============== - -To install OpenAL Soft, use your favorite shell to go into the build/ -directory, and run: - -cmake .. - -Assuming configuration went well, you can then build it, typically using GNU -Make (KDevelop, MSVC, and others are possible depending on your system setup -and CMake configuration). - -Please Note: Double check that the appropriate backends were detected. Often, -complaints of no sound, crashing, and missing devices can be solved by making -sure the correct backends are being used. CMake's output will identify which -backends were enabled. - -For most systems, you will likely want to make sure ALSA, OSS, and PulseAudio -were detected (if your target system uses them). For Windows, make sure -DirectSound was detected. - - -Utilities -========= - -The source package comes with an informational utility, openal-info, and is -built by default. It prints out information provided by the ALC and AL sub- -systems, including discovered devices, version information, and extensions. - - -Configuration -============= - -OpenAL Soft can be configured on a per-user and per-system basis. This allows -users and sysadmins to control information provided to applications, as well -as application-agnostic behavior of the library. See alsoftrc.sample for -available settings. - - -Acknowledgements -================ - -Special thanks go to: - -Creative Labs for the original source code this is based off of. - -Christopher Fitzgerald for the current reverb effect implementation, and -helping with the low-pass and HRTF filters. - -Christian Borss for the 3D panning code previous versions used as a base. - -Ben Davis for the idea behind a previous version of the click-removal code. - -Richard Furse for helping with my understanding of Ambisonics that is used by -the various parts of the library. |