Skip to content

Commit 8633971

Browse files
generic-pers0nRossBencinaphilburk
authored
Rewrite CMake build documentation (#1044)
Rewrite CMake documentation: The intent of rewriting the documentation is to hopefully make it much clearer how to build PortAudio with CMake. It features a list of all PortAudio build options (including some general CMake options), the general process, and more organized build instructions. Signed-off-by: Avery King <gperson@disroot.org> * Copy edit for clarity * Move ASIO warning to Compiling With ASIO Support section * Document using local builds * Add an optional step installing a local PortAudio build * Describe using find_package() with locally installed builds * Reorganize first steps * Add a prerequisites section documenting needed software * Revise step 1 to also document how Git is not necessary * Replace nmake and jom with msbuild * Clarify and correct build paths and configurations * Explain that static libraries are built by default and how to get a shared library for each platform. * Explain where binaries are located on Windows vs Unix. * Correct '--configuration' to '--config'. * Rewrite CMake's --config parameter explanation * Correct CMAKE_INSTALL_PREFIX name * Explain when CMake options are applied Except for --config, all CMake options are always applied during the configure step. --config, however, isn't always applied during the configure step. * Clarify building and running tests and examples * Account for the Windows (and multi-config generator) differences when listing all tests and examples and running them. * We default to PA_BUILD_SHARED_LIBS=ON, update the docs accordingly Co-authored-by: Ross Bencina <rossb@audiomulch.com> * Preview the main steps of the process. * Grammar cleanups Co-authored-by: Phil Burk <philburk@mobileer.com> --------- Signed-off-by: Avery King <gperson@disroot.org> Co-authored-by: Ross Bencina <rossb@audiomulch.com> Co-authored-by: Phil Burk <philburk@mobileer.com>
1 parent 6838738 commit 8633971

1 file changed

Lines changed: 307 additions & 30 deletions

File tree

0 commit comments

Comments
 (0)