Add copy-pastable build instructions #159
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The main value here is to put `CMAKE_GENERATOR=Ninja` front-and-center, so that users realize that extra steps are needed for a parallel build. It _is_ documented quite clearly already, but, from my very personal experience: * people don't read the docs and spend hours hammering one poor core * even if people do read the docs, when the come back to the repo the second time around, they forget, and hammer that single poor core _again_ :-)
|
This makes it look like ninja is a requirement rather than an option.
Perhaps we could put |
|
I think ninja is a better default (simpler, faster, consistent across platforms), so, given that we already need CMake, nudging towards ninja seems like the right call. |
|
Maybe also add Windows Build Instructions to TL;DR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main value here is to put
CMAKE_GENERATOR=Ninjafront-and-center, so that users realize that extra steps are needed for a parallel build.It is documented quite clearly already, but, from my very personal experience: