Skip to content

Commit

Permalink
[doc] add cloning swift-collection to bootstrap documentation
Browse files Browse the repository at this point in the history
Also updated version numbers used for swift-argument-parser and swift-crypto in the documentation.
  • Loading branch information
WowbaggersLiquidLunch committed Jun 9, 2021
1 parent fe8c477 commit 374bf40
Showing 1 changed file with 35 additions and 34 deletions.
69 changes: 35 additions & 34 deletions Documentation/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,40 +128,41 @@ It is used on bare systems to bootstrap the Swift toolchain (including SwiftPM),
the bootstrap script requires having [CMake](https://cmake.org/) and [Ninja](https://ninja-build.org/) installed.
Please refer to the [Swift project repo](https://github.com/apple/swift/blob/master/README.md#macos) for installation instructions.

1. Clone [llbuild](https://github.com/apple/swift-llbuild) beside the SwiftPM directory.

```bash
$> git clone https://github.com/apple/swift-llbuild llbuild
```

Note: Make sure the directory for llbuild is called "llbuild" and not
"swift-llbuild".

2. Clone [Yams](https://github.com/jpsim/yams) beside the SwiftPM directory.

```bash
$> git clone https://github.com/jpsim/yams
```

3. Clone [swift-driver](https://github.com/apple/swift-driver) beside the SwiftPM directory.

```bash
$> git clone https://github.com/apple/swift-driver
```

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).

For example, if the latest tag is 0.3.1:
```bash
$> git clone https://github.com/apple/swift-argument-parser --branch 0.3.1
```

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).

For example, if the latest tag is 1.1.3:
```bash
$> git clone https://github.com/apple/swift-crypto --branch 1.1.3
```
1. Clone [llbuild], [swift-driver], and [Yams] beside the SwiftPM directory.

```sh
$> git clone https://github.com/apple/swift-llbuild llbuild
$> git clone https://github.com/apple/swift-driver
$> git clone https://github.com/jpsim/yams

```

> **Note**: Make sure the directory for llbuild is called "llbuild" and not "swift-llbuild".
[llbuild]: https://github.com/apple/swift-llbuild
[swift-driver]: https://github.com/apple/swift-driver
[Yams]: https://github.com/jpsim/yams

2. 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).

For example, if the latest tag is 0.4.3:
```sh
$> git clone https://github.com/apple/swift-argument-parser --branch 0.4.3
```

3. Clone [swift-collections](https://github.com/apple/swift-collections) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-collections/tags).

For example, if the latest tag is 0.0.3:
```sh
$> git clone https://github.com/apple/swift-collections --branch 0.0.3
```

4. 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).

For example, if the latest tag is 1.1.4:
```sh
$> git clone https://github.com/apple/swift-crypto --branch 1.1.4
```

#### Building

Expand Down

0 comments on commit 374bf40

Please sign in to comment.