Skip to content

Commit

Permalink
Add section about building examples to CMake docs
Browse files Browse the repository at this point in the history
  • Loading branch information
generic-pers0n committed Dec 6, 2024
1 parent b4c4406 commit 174e193
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/src/tutorial/compile_cmake.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ If you want ASIO support you need to obtain the ASIO2 SDK from Steinberg and pla

<b>Note</b>: 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
Expand Down

0 comments on commit 174e193

Please sign in to comment.