Skip to content

Commit 5d6cc90

Browse files
committed
[Docs] Tidy up README a bit.
1 parent 8dda2e3 commit 5d6cc90

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Swift Package Manager Project
22

3-
> **PLEASE NOTE** The Swift Package Manager is still in early design and development — we are aiming to have it stable and ready for use with Swift 3 but currently all details are subject to change and many important features are yet to be implemented. Additionally, it is important to note that the Swift language syntax is not stable, so packages you write will (likely) break as Swift evolves.
3+
> **PLEASE NOTE** The Swift Package Manager is still in early design and development — we are aiming to have it stable and ready for use with Swift 3 but currently all details are subject to change and many important features are yet to be implemented. Additionally, it is important to note that the Swift language syntax is not stable, so packages you write will (likely) break as Swift evolves.
44
55
The Swift Package Manager is a tool for managing distribution of source code, aimed at making it easy to share your code and reuse others’ code. The tool directly addresses the challenges of compiling and linking Swift packages, managing dependencies, versioning, and supporting flexible distribution and collaboration models.
66

7-
We’ve designed the system to make it really easy to share packages on services like GitHub, but packages are also great for private personal development, sharing code within a team, or at any other granularity.
7+
We’ve designed the system to make it easy to share packages on services like GitHub, but packages are also great for private personal development, sharing code within a team, or at any other granularity.
88

99
---
1010

@@ -52,10 +52,6 @@ The package manager is bundled with the [**Trunk Development** Snapshots availab
5252

5353
export TOOLCHAINS=swift
5454

55-
* Xcode 7.2:
56-
57-
export PATH=/Library/Toolchains/swift-latest.xctoolchain/usr/bin:$PATH
58-
5955
* Linux:
6056

6157
export PATH=path/to/toolchain/usr/bin:$PATH
@@ -73,7 +69,7 @@ The following indicates you have not installed a snapshot successfully:
7369

7470
### Managing Swift Environments
7571

76-
The `TOOLCHAINS` environment variable on OS X can be used to control which `swift` is instantiated:
72+
The `TOOLCHAINS` environment variable on OS X can be used to control which `swift` is executed:
7773

7874
```sh
7975
$ xcrun --find swift
@@ -91,13 +87,13 @@ On OS X `/usr/bin/swift` is just a stub that forwards invocations to the active
9187

9288
To use a specific toolchain you can set `TOOLCHAINS` to the `CFBundleIdentifier` in an `.xctoolchain`’s Info.plist.
9389

94-
This feature requires Xcode 7.3.
90+
This feature requires Xcode 7.3 or later.
9591

9692
---
9793

9894
## Development
9995

100-
The Package Manager is itself a Swift Package and thus can be used to build itself. However we recommend instead one of the three following options:
96+
The Package Manager project is itself a Swift Package and can be used to build itself. If you are interested in contributing to the package manager, however, we recommend one of the three following options:
10197

10298
1. Using the [Swift project `build-script`](https://github.com/apple/swift/blob/master/README.md):
10399

@@ -120,19 +116,19 @@ Note that either of the latter two options may not be compatible with the `maste
120116

121117
### Choosing a Swift Version
122118

123-
The `SWIFT_EXEC` environment variable specifies the `swiftc` executable path used by `swift package`. If it is not set, SwiftPM will try to locate it:
119+
The `SWIFT_EXEC` environment variable specifies the `swiftc` executable path used by `swift package`. If it is not set, the package manager will try to locate it:
124120

125-
1. In `swift-package`'s parent directory.
126-
2. (on OS X) by calling `xcrun --find swiftc`
127-
3. in PATH
121+
1. In `swift-package`'s parent directory.
122+
2. On OS X, by calling `xcrun --find swiftc`.
123+
3. By searching the PATH.
128124

129125
---
130126

131127
## Documentation
132128

133-
For extensive documentation on using Swift Package Manager, creating packages, and more, see [Documentation/README](Documentation/README.md).
129+
For extensive documentation on using Swift Package Manager, creating packages, and more, see [Documentation](Documentation).
134130

135-
For additional documentation on developing Swift Package Manager, see [Documentation/Internals](Documentation/Internals).
131+
For additional documentation on developing the Swift Package Manager itself, see [Documentation/Internals](Documentation/Internals).
136132

137133
---
138134

0 commit comments

Comments
 (0)