-
Notifications
You must be signed in to change notification settings - Fork 311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve CMake docs #985
base: master
Are you sure you want to change the base?
Improve CMake docs #985
Conversation
69bd14d
to
b8e0594
Compare
Fantastic that you are working on this, it's much appreciated. I agree that #963 should be merged first. Phil and I were hoping that we could get some feedback from CMake users before merging it. |
We've merged #963 |
b8e0594
to
d5bece8
Compare
Since #963 was merged, I'm marking this PR as ready to review. I also have one question: should we recommend CMake over the other build systems? I can try to chip in whenever other CMake related PRs come up, although I don't consider myself a "CMake expert" but can try to help out whenever I can anyways. (And I know it's late, but I think #963 was fine, especially considering I was operating under the assumption of its eventual merge). |
Your offer of ongoing assistance is much appreciated.
Not for the forseeable future. |
d5bece8
to
61d4f32
Compare
61d4f32
to
7fe783c
Compare
- Update target names - Mention auto-download of ASIO SDK - Mention Ninja for Linux and OS X
7fe783c
to
f0bad14
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for addressing my comments. We will test the current docs before merging.
f0bad14
to
174e193
Compare
This PR intends to solve #662 by updating the documentation to better cover CMake.
Note that as far as I understand, it appears that the process of building with CMake hasn't changed much and remains fundamentally the same even after #461 and the subsequent PRs, maybe perhaps with a few changes in targets and build options. I could be extremely wrong, but either way, I try to cover the changes in target names from 19.7 to the latest development version and also add a full list of CMake build options. I also mention Ninja as an alternative to the traditional make since it also works in the same way as it too.
I'm currently marking this draft as a PR because I'm looking at refining more of the build documentation given #662 (comment). Early feedback is appreciated, but always keep in mind that things will change! 😄
EDIT: I forgot to mention that I saw #963, and I just want to say that this PR can be updated to reflect any changes should that PR get merged before this one. (It might be preferable to have that PR merged before this one).