diff options
| author | kcat <[email protected]> | 2018-01-27 19:03:50 -0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2018-01-27 19:03:50 -0800 |
| commit | 277127829a0f8898044f508cb3093a7abce11e19 (patch) | |
| tree | befdc88435a349b95246fcc8189cb7d6598768d5 | |
| parent | 031cf248808df8cc7d0af2a5c5174d189af7a4ac (diff) | |
| parent | 58fd9d70d250047c2edd8a35b69d0e2f10948dad (diff) | |
Merge pull request #166 from Ybalrid/betterReadme
Better readme
| -rw-r--r-- | README.md | 20 |
1 files changed, 14 insertions, 6 deletions
@@ -1,6 +1,15 @@ -Source Install -============== +OpenAL soft +=========== + +`master` branch CI status : [](https://travis-ci.org/kcat/openal-soft) [](https://ci.appveyor.com/api/projects/status/github/kcat/openal-soft?branch=master&svg=true) + +OpenAL Soft is an LGPL-licensed, cross-platform, software implementation of the OpenAL 3D audio API. It's forked from the open-sourced Windows version available originally from openal.org's SVN repository (now defunct). +OpenAL provides capabilities for playing audio in a virtual 3D environment. Distance attenuation, doppler shift, and directional sound emitters are among the features handled by the API. More advanced effects, including air absorption, occlusion, and environmental reverb, are available through the EFX extension. It also facilitates streaming audio, multi-channel buffers, and audio capture. +More information is available on the [official website](http://openal-soft.org/) + +Source Install +------------- To install OpenAL Soft, use your favorite shell to go into the build/ directory, and run: @@ -23,15 +32,14 @@ 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 @@ -40,7 +48,7 @@ available settings. Acknowledgements -================ +---------------- Special thanks go to: |