diff options
| author | Chris Robinson <[email protected]> | 2023-01-28 03:09:02 -0800 |
|---|---|---|
| committer | Chris Robinson <[email protected]> | 2023-01-28 03:09:02 -0800 |
| commit | 02ec1e12086c84015c98bd5fd166be6cccf29f5d (patch) | |
| tree | fb0ee50b6d273fdd075e83b476fc97ee51106bb3 /README.md | |
| parent | dc61e7c59d24fb4422c3ea939eeb32ef2f4038c4 (diff) | |
Update the readme
Travis CI has been down for years, so replace the build badge with GitHub
Actions' badge.
Update the build instructions to note CMake GUIs as an alternative to the
command line, and note various IDE's potentially supporting CMake projects
directly.
Finally, update the list of expected backends for Linux and Windows.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 11 insertions, 7 deletions
@@ -1,7 +1,7 @@ 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) +`master` branch CI status : [](https://github.com/kcat/openal-soft/actions) [](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. @@ -17,18 +17,22 @@ 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). +Alternatively, you can use any available CMake front-end, like cmake-gui, +ccmake, or your preferred IDE's CMake project parser. + +Assuming configuration went well, you can then build it. The command +`cmake --build .` will instruct CMake to execute the build with the toolchain +chosen during configuration (often GNU Make or NMake, although others are +possible). 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. +For most systems, you will likely want to make sure PipeWire, PulseAudio, and +ALSA were detected (if your target system uses them). For Windows, make sure +WASAPI was detected. Building openal-soft - Using vcpkg |