This repository was archived by the owner on Apr 6, 2026. It is now read-only.
docs: Update build instructions to match CI - #164
Merged
Conversation
itsananderson
force-pushed
the
readme-build-instructions
branch
from
August 25, 2025 23:58
22d428a to
0d8c3b8
Compare
erickzhao
approved these changes
Aug 26, 2025
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
When building locally with the
cmake --build .instructions in the README, I get the following error:Sounds like this failure is because CMake is trying to include runtime error checks (
/RTC1) but also produce fully optimized code (/Ox) which isn't supported.I looked at what the CI job is doing, and it apparently passes a
--config RelWithDebInfoflag to cmake. When I added that locally, the build succeeded. Updating the docs to include that flag seems like the easiest solution, but I'm open to other ideas as well (like only addingadd_compile_options(/Ox /Os)for release builds).Fixes #159