Skip to content

Commit a3e5aa4

Browse files
[gardening] add missing "clone TSC" step to bootstrap instructions (#3598)
1 parent 4fd4df4 commit a3e5aa4

File tree

1 file changed

+45
-34
lines changed

1 file changed

+45
-34
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -129,40 +129,51 @@ It is used on bare systems to bootstrap the Swift toolchain (including SwiftPM),
129129
The bootstrap script requires having [CMake](https://cmake.org/) and [Ninja](https://ninja-build.org/) installed.
130130
Please refer to the [_Get Started_ guide](https://github.com/apple/swift/blob/main/docs/HowToGuides/GettingStarted.md#installing-dependencies) on the Swift project repository for installation instructions.
131131

132-
1. Clone [llbuild](https://github.com/apple/swift-llbuild) beside the SwiftPM directory.
133-
134-
```bash
135-
$> git clone https://github.com/apple/swift-llbuild llbuild
136-
```
137-
138-
Note: Make sure the directory for llbuild is called "llbuild" and not
139-
"swift-llbuild".
140-
141-
2. Clone [Yams](https://github.com/jpsim/yams) beside the SwiftPM directory.
142-
143-
```bash
144-
$> git clone https://github.com/jpsim/yams
145-
```
146-
147-
3. Clone [swift-driver](https://github.com/apple/swift-driver) beside the SwiftPM directory.
148-
149-
```bash
150-
$> git clone https://github.com/apple/swift-driver
151-
```
152-
153-
4. Clone [swift-argument-parser](https://github.com/apple/swift-argument-parser) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).
154-
155-
For example, if the latest tag is 0.3.1:
156-
```bash
157-
$> git clone https://github.com/apple/swift-argument-parser --branch 0.3.1
158-
```
159-
160-
5. Clone [swift-crypto](https://github.com/apple/swift-crypto) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).
161-
162-
For example, if the latest tag is 1.1.3:
163-
```bash
164-
$> git clone https://github.com/apple/swift-crypto --branch 1.1.3
165-
```
132+
Clone the following repositories beside the SwiftPM directory:
133+
134+
1. [swift-argument-parser] and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).
135+
136+
For example, if the latest tag is 0.4.3:
137+
```sh
138+
$> git clone https://github.com/apple/swift-argument-parser --branch 0.4.3
139+
```
140+
141+
2. [swift-llbuild] as llbuild
142+
```sh
143+
$> git clone https://github.com/apple/swift-llbuild llbuild
144+
```
145+
> Note: Make sure the directory for llbuild is called "llbuild" and not "swift-llbuild".
146+
147+
3. [swift-tools-support-core]
148+
```sh
149+
$> git clone https://github.com/apple/swift-tools-support-core
150+
```
151+
152+
4. [Yams] and checkout tag with the [latest version](https://github.com/jpsim/Yams.git/tags) before 5.0.0.
153+
154+
For example, if the latest tag is 4.0.6:
155+
```sh
156+
$> git clone https://github.com/jpsim/yams --branch 4.0.6
157+
```
158+
159+
5. [swift-driver]
160+
```sh
161+
$> git clone https://github.com/apple/swift-driver
162+
```
163+
164+
6. [swift-crypto] and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).
165+
166+
For example, if the latest tag is 1.1.6:
167+
```sh
168+
$> git clone https://github.com/apple/swift-crypto --branch 1.1.6
169+
```
170+
171+
[swift-argument-parser]: https://github.com/apple/swift-argument-parser
172+
[swift-crypto]: https://github.com/apple/swift-crypto
173+
[swift-driver]: https://github.com/apple/swift-driver
174+
[swift-llbuild]: https://github.com/apple/swift-llbuild
175+
[swift-tools-support-core]: https://github.com/apple/swift-tools-support-core
176+
[Yams]: https://github.com/jpsim/yams
166177

167178
#### Building
168179

0 commit comments

Comments
 (0)