-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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 Cross-Platform Build Instructions in Documentation #3229
Conversation
Thanks. Could you make it shorter? It takes now 7 lines |
Thank you for your reply. Okay, I'll do that. |
I compiled the tests in Ubuntu22.04 using gcc11 and windows 11 using the Developer PowerShell for VS 2022 terminal with no problems. |
using the original && style is better. All is needed is replacing a single line: the “make build -j” line with cmake —build .” |
The problem is that windows powershell terminals don't support this! |
Of course, if you like, of course. |
Maybe the logical difference counts here. Users may stop copying-pasting commands when one of mutiple lines failed, but with In addtion, |
Merged. Thanks @Mq-b |
* Update build * Simplified build command length for cross-platform compatibility. * Modified to replace `make -j` only with `cmake --build.`
Description:
This PR updates the build instructions in the documentation to make them more cross-platform and compatible with different development environments, such as Windows with MSVC.
Details:
Previously, the documentation included commands specific to GNU-based toolchains, notably
make
. However, this can be problematic for users on non-GNU systems (such as Windows with MSVC), wheremake
is not available by default. This update replacesmake -j
with the more universally supportedcmake --build . --parallel
and adds a clearcmake --install .
command for the installation step.Reasoning:
MSBuild
on Windows,make
on Unix-like systems).cmake --build
andcmake --install
promotes consistency with CMake’s intended workflows and is less reliant on external toolchains.Thank you for considering this contribution to enhance the usability of the build instructions for a broader range of developers.