From 6562a939ea5a5b582d6aa182f3f6fa7411a5e222 Mon Sep 17 00:00:00 2001 From: Arthur Brainville Date: Sun, 28 Jan 2018 01:37:00 +0100 Subject: [PATCH 1/3] Add project overview and travis build badge Signed-off-by: Arthur Brainville (Ybalrid) --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3071163f..42d12fda 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ -Source Install -============== +OpenAL-soft +=========== +CI status : [![Build Status](https://travis-ci.org/kcat/openal-soft.svg?branch=master)](https://travis-ci.org/kcat/openal-soft) + +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 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: From d2cf61c99aa46561f6a32d4194c149c5c5bca4e0 Mon Sep 17 00:00:00 2001 From: Arthur Brainville Date: Sun, 28 Jan 2018 02:29:54 +0100 Subject: [PATCH 2/3] Added AppVeyor badge --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 42d12fda..ecfd855b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ OpenAL-soft =========== -CI status : [![Build Status](https://travis-ci.org/kcat/openal-soft.svg?branch=master)](https://travis-ci.org/kcat/openal-soft) +`master` branch CI status : [![Build Status](https://travis-ci.org/kcat/openal-soft.svg?branch=master)](https://travis-ci.org/kcat/openal-soft) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/kcat/openal-soft?branch=master&svg=true)](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 available on the [official website](http://openal-soft.org/) +More information are available on the [official website](http://openal-soft.org/) Source Install ------------- From 58fd9d70d250047c2edd8a35b69d0e2f10948dad Mon Sep 17 00:00:00 2001 From: Arthur Brainville Date: Sun, 28 Jan 2018 03:26:02 +0100 Subject: [PATCH 3/3] Additional corrections as mentionned in the PR --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ecfd855b..0c9d3027 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -OpenAL-soft +OpenAL soft =========== `master` branch CI status : [![Build Status](https://travis-ci.org/kcat/openal-soft.svg?branch=master)](https://travis-ci.org/kcat/openal-soft) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/kcat/openal-soft?branch=master&svg=true)](https://ci.appveyor.com/api/projects/status/github/kcat/openal-soft?branch=master&svg=true) @@ -6,7 +6,7 @@ OpenAL-soft 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 are available on the [official website](http://openal-soft.org/) +More information is available on the [official website](http://openal-soft.org/) Source Install -------------