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.

Sign up for GitHub

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

Update cmake section in readme with required env-vars #769

Merged
merged 8 commits into from
Dec 2, 2023
Merged

Update cmake section in readme with required env-vars #769

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d41f31f
update cmake section in readme with required env-vars
tonka3000 Oct 28, 2023
9593668
Update README.md
tonka3000 Oct 29, 2023
7f92aa4
add vswhere
tonka3000 Oct 29, 2023
e5bcb58
use correct windows Path writing
tonka3000 Oct 29, 2023
4fec4e0
Update README.md
tonka3000 Nov 1, 2023
a06725c
add powershell command line and 5.10 path env-vars
tonka3000 Nov 1, 2023
49c12a9
use systemdrive
tonka3000 Nov 1, 2023
6f7146c
Update README.md
tonka3000 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,49 @@ ninja -C build SwiftWin32 UICatalog
%CD%\build\bin\UICatalog.exe
```

Following environment variables should be set/adjusted before run the above commands (the shown paths assume that you use compiler from the official swift installers from [swift.org](https://www.swift.org/download/)).

- Visual Studio compiler toolchain

The CMake commands use the `mt` tool which requires a Visual Studio compiler environment (Build Tools should be fine too).
e.g. if you have Visual Studio 2019 installed you can create a command prompt by click on `x64 Native Tools Command Prompt for VS2019` from the Visual Studio 2019 installation in the Windows Start Menu.

Newer versions of Visual Studio or the corresponding Build Tools should be fine too.

Another way of activating a Visual Studio environment is the tool [vswhere](https://github.com/microsoft/vswhere).

- `SDKROOT`

This should be the path to the Windows Platform SDK from the Swift library. This should be already set by the official swift installer. If not set the env var.

\>= 5.10 `SDKROOT` needs to be `%LocalAppData%\Programs\Swift\Platforms\Windows.platform\Developer\SDKs\Windows.sdk`

< 5.10 `SDKROOT` needs to be `%SystemDrive%\Library\Developer\Platforms\Windows.platform\Developer\SDKs\Windows.sdk`

Examples for < 5.10:

Command Prompt: `set SDKROOT=%SystemDrive%\Library\Developer\Platforms\Windows.platform\Developer\SDKs\Windows.sdk`

PowerShell: `$env:SDKROOT="%SystemDrive%\Library\Developer\Platforms\Windows.platform\Developer\SDKs\Windows.sdk"`

- `Path`

The `Path` environment variables needs to be extended to allow the Swift compiler to be found.
This is only required when this is not already the case.
When you type `where swiftc` (`(Get-Command swiftc).Path` for PowerShell) and see no path to `swiftc` the following command is required.

\>= 5.10 the `Path` needs to extended with `%LocalAppData%\Programs\Swift\Runtimes\5.9.0\usr\bin;%LocalAppData%\Programs\Swift\Toolchains\5.9.0+Asserts\usr\bin`

< 5.10 the `Path` needs to be extended with `%SystemDrive%\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin`

Examples for < 5.10:

Command Prompt: `set Path=%SystemDrive%\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin;%Path%`

PowerShell: `$env:Path="%SystemDrive%\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin;$env:Path"`



### Swift Package Manager

Building this project with swift-package-manager is supported although CMake is recommended for ease. The Swift Package Manager based build is required for code completion via SourceKit-LSP. It also allows for the use of Swift/Win32 in other applications using SPM. In order to use SPM to build this project additional post-build steps are required to use the demo applications.
Expand Down