From 174e1938da84cf4b76c1e1ac845af8dc1c505012 Mon Sep 17 00:00:00 2001 From: Avery King Date: Thu, 28 Nov 2024 13:22:16 -0800 Subject: [PATCH] Add section about building examples to CMake docs --- doc/src/tutorial/compile_cmake.dox | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/src/tutorial/compile_cmake.dox b/doc/src/tutorial/compile_cmake.dox index 31e13951d..224c5a319 100644 --- a/doc/src/tutorial/compile_cmake.dox +++ b/doc/src/tutorial/compile_cmake.dox @@ -37,6 +37,18 @@ If you want ASIO support you need to obtain the ASIO2 SDK from Steinberg and pla Note: If you are using CMake 3.18 or later, PortAudio can automatically download and extract the ASIO2 SDK for you. +@section Building Examples + +Building the examples with CMake are very straightfoward. All you have to do is add `-DPA_BUILD_EXAMPLES=ON` to your CMake options. For example, if you are building PortAudio like this: + + build_path> cmake /path/to/portaudio/source + +Then you would add `-DPA_BUILD_EXAMPLES=ON` like so: + + build_path> cmake **-DPA_BUILD_EXAMPLES=ON** /path/to/portaudio/source + +Afterwards, continue the build process as normal. Once the build finishes, there will be an `examples/` folder containing all the examples where you can try out PortAudio in action. + @section Building Tests Unlike some of our other build systems (e.g., autotools), tests are not built automatically. In that case, you can add