Add prerequisites section to Windows install page #1313
Conversation
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
…rerequisites section at the top of the Windows installation page. This helps prevent build errors from users installing Swift without required dependencies. Changes: - Add Prerequisites section with dependencies documentation - Include note explaining WinGet auto-installs VS vs manual install - Update section 1 heading to clarify dependencies are included Fixes swiftlang#666
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add prerequisites section to Windows install page
Make Visual Studio requirement more prominent by adding a dedicated prerequisites section at the top of the Windows installation page. This helps prevent build errors from users installing Swift without required dependencies.
Motivation:
The Windows install page did not make it sufficiently obvious that Visual Studio is a required prerequisite for Swift. Users who missed this requirement encountered cryptic build errors like 'stdint.h' file not found when attempting to compile Swift code. Issue #666 documented this problem where new users could easily skip the Visual Studio installation, especially when using the manual installer route.
Modifications:
Result:
Users visiting the Windows installation page will now immediately see the prerequisites section with Visual Studio clearly listed as a required dependency. This prevents confusion and reduces support burden from users who attempt to use Swift without the necessary platform dependencies installed.
Fixes #763