Skip to content

Commit f56b330

Browse files
committedNov 10, 2020
docs: expand on SPM build instructions
Add notes on the known limitations with SPM and explain the scenarios where SPM is required.
1 parent 88b53e9 commit f56b330

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed
 

Diff for: ‎README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@ ninja -C build SwiftWin32 UICatalog
3030

3131
### Experimental (Swift Package Manager)
3232

33-
Building this project with swift-package-manager is experimental and does not fully function. In particular, it is not possible to deploy auxiliary files which are required for Swift/Win32 based applications to function to the correct location. However, the swift-package-manager build can be used with additional manual steps. This also enables the use of VSCode and SourceKit-LSP to develop Swift/Win32 as well as applications using this library.
33+
Building this project with swift-package-manager is supported on an experimental basis. The SPM 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.
34+
35+
The following known limitations are known:
36+
37+
1. It is not possible to deploy auxiliary files which are required for Swift/Win32 based applications to function to the correct location.
38+
2. It is not possible to build and run multiple demo projects as the auxiliary files collide.
3439

3540
```cmd
3641
swift build --product UICatalog

0 commit comments

Comments
 (0)