Skip to content
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

Add copy-pastable build instructions #159

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

matklad
Copy link

@matklad matklad commented Aug 25, 2023

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 :-)

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_ :-)
@daurnimator
Copy link

This makes it look like ninja is a requirement rather than an option.

people don't read the docs and spend hours hammering one poor core

Perhaps we could put CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) instead?

@matklad
Copy link
Author

matklad commented Aug 26, 2023

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.

@LinuxUserGD
Copy link
Contributor

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants