Link Windows contributors to the existing Windows setup docs - #133
Open
djkees wants to merge 1 commit into
Open
Conversation
* Link Windows contributors to the existing Windows setup docs (#51, #52) README's plain source-build quickstart and CONTRIBUTING's dev preset both fail immediately on Windows with no pointer to the working Windows flow already documented in installation.rst. * Show a concrete Windows cmake command in README's Windows callout The callout named the fix (-G flag) without a runnable example; add one for the common Visual Studio case, matching installation.rst's own generator guidance. (cherry picked from commit f73a700)
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 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.
Summary
README's plain source-build quickstart and CONTRIBUTING's recommended
devpreset both fail immediately on Windows, with no signal that Windows needs different handling and no link to the doc page that already has it.djkees#51
djkees#52
Changes
cmake/cmake --build/cmake --installquickstart, explaining that an explicit-Ggenerator is required on Windows (no Visual Studio means CMake silently defaults to NMake Makefiles and fails before reaching the Fortran compiler), linking to installation.rst's Windows Notes section.dev/dev-intel/dev-ub-huntall lock the Unix Makefiles generator and target GNU toolchains, so they fail outright on Windows (CMAKE_MAKE_PROGRAM is not set), pointing to the same Windows Notes section instead.Both link to installation.rst's existing Windows Notes / Windows + Intel oneAPI sections, which already have validated Windows instructions — this PR only makes sure Windows readers get routed there instead of hitting an unexplained failure first.
Testing
Compatibility / Numerical behavior
Drafted with Claude's assistance