PortAudio / portaudio

PortAudio is a cross-platform, open-source C language library for real-time audio input and output.
Other
1.45k stars 303 forks source link

Update CMake instructions in the PortAudio Tutorial #662

Open philburk opened 2 years ago

philburk commented 2 years ago

We describe using ./configure but CMake is now a good alternative and should be documented.

Document building libraries, examples, tests and MSVC projects.

RossBencina commented 2 years ago

The existing CMake build instructions are here:

http://files.portaudio.com/docs/v19-doxydocs/compile_cmake.html

The source is here if anyone would like to edit it and submit a PR:

https://github.com/PortAudio/portaudio/blob/master/doc/src/tutorial/compile_cmake.dox

Off the top of my head one thing that should be covered is how to build shared vs. static lib as I think this has changed.

We should also clean up the build instruction links here to make it clear what build systems we support:

http://files.portaudio.com/docs/v19-doxydocs/tutorial_start.html

Be-ing commented 2 years ago

I'll make a PR soon.

philburk commented 2 years ago

I found that this sequence worked to build the examples and tests:

mkdir cbuild
cd cbuild
cmake -DPA_BUILD_EXAMPLES=ON  -DPA_BUILD_TESTS=ON ..
make
examples/paex_sine
RossBencina commented 2 years ago

Related #486

RossBencina commented 1 year ago

@Be-ing please fix this, it's a P2 and we're getting complaints:

https://github.com/PortAudio/portaudio/issues/748

RossBencina commented 1 month ago

I've made PR #951 to update the docs with warnings and annotations about inconsistencies between our docs and CMake

Honestly this is a disgrace. I should not have approved the merge of CMakeLists.txt changes without accompanying updates to the documentation. With this ticket being open for almost 3 years, with no PortAudio CMake developers stepping up to fix it, the obvious conclusion is that CMake is an unsupported build system for PortAudio.

RossBencina commented 1 month ago

Removed @Be-ing as assignee, clearly they have moved on.