You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/Contributing.md
+23-11Lines changed: 23 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
# Swift Package Manager: Quick Start
2
-
Swift Package Manager (SwiftPM) is a tool for building, testing and managing Swift project dependencies.
3
-
In order to use it you will need Swift 3.0 or greater.
4
-
SwiftPM is also included in Xcode 8.0 and above.
5
-
For usage getting started: [https://swift.org/getting-started/#using-the-package-manager](https://swift.org/getting-started/#using-the-package-manager)
2
+
Swift Package Manager (SwiftPM) is a tool for building, testing and managing Swift project dependencies.
3
+
In order to use it you will need Swift 3.0 or greater.
4
+
SwiftPM is also included in Xcode 8.0 and above.
5
+
For usage getting started: [https://swift.org/getting-started/#using-the-package-manager](https://swift.org/getting-started/#using-the-package-manager)
6
6
For overview and examples: [https://swift.org/package-manager](https://swift.org/package-manager/)
7
7
8
8
## Code Contributions
9
-
Everyone is welcome to contribute to SwiftPM, submitting fixes, enhancement etc.
9
+
Everyone is welcome to contribute to SwiftPM, submitting fixes, enhancement etc.
10
10
Find out how previous coding decisions for SwiftPM evolution have been made: https://github.com/apple/swift-package-manager/blob/main/Documentation/Internals/PackageManagerCommunityProposal.md
11
11
12
12
### Requirements
13
-
You have multiple ways to setup your development environment, here we will focus on 2:
13
+
You have multiple ways to setup your development environment, here we will focus on 2:
14
14
A) *[Using Xcode](#using-xcode)* or B) [Using *the standalone Swift toolchain*](#using-standalone).
15
15
16
16
<aid="using-xcode">*A) _Use Xcode to setup what you need_*.</a>
If the build process ends with exit code 0, the build is successful (we have an Enhancement Radar to implement a message for successful build and a short output on where the generated binaries are: rdar://69970428).
59
+
If the build process ends with exit code 0, the build is successful (we have an Enhancement Radar to implement a message for successful build and a short output on where the generated binaries are: rdar://69970428).
60
60
After a successful build (currently), you should see something like this:
61
61
```
62
62
[476/476] Linking swift-package
@@ -72,7 +72,7 @@ debug.yaml
72
72
manifest.db
73
73
workspace-state.json
74
74
```
75
-
Binaries (in the example above) are in `x86_64-apple-macosx/`
75
+
Binaries (in the example above) are in `x86_64-apple-macosx/`.
76
76
If you need to build the generated binaries, run `swift-build` in inside `.build/`:
77
77
```
78
78
./.build/x86_64-apple-macosx/debug/swift-build
@@ -96,8 +96,8 @@ If you are contributing using macOS, the best option is to use Xcode to build an
96
96
^
97
97
( )
98
98
```
99
-
Do not worry, since those are known warnings that will be addressed at some point.
100
-
Warnings differ depending on the platform and they can be seen from time to time due the amount of contributions.
99
+
Do not worry, since those are known warnings that will be addressed at some point.
100
+
Warnings differ depending on the platform and they can be seen from time to time due the amount of contributions.
101
101
Our goal is to constantly monitor warnings and work on fix them (even if they are not affecting a successful implementation).
102
102
* If during `swift build` you encounter this error:
103
103
```
@@ -110,9 +110,21 @@ Make sure you are using SwiftPM 5.3
110
110
$> swift package --version
111
111
Swift Package Manager - Swift 5.3.0
112
112
```
113
+
* If during `swift build` you encounter this error:
114
+
```
115
+
/../swift-package-manager/Sources/PackageLoading/Target+PkgConfig.swift:84:36: error: type 'PkgConfigError' has no member 'prohibitedFlags'
Report a bug guide: https://github.com/apple/swift-package-manager/blob/main/Documentation/Resources.md#reporting-a-good-swiftpm-bug.
127
+
Report a bug guide: https://github.com/apple/swift-package-manager/blob/main/Documentation/Resources.md#reporting-a-good-swiftpm-bug.
116
128
JIRA Bug Tracker (a place where you can open bugs, enhancements to start to contribute): [https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22](https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22).
0 commit comments