Skip to content

Commit ab89001

Browse files
authored
Merge pull request #328 from MuhammadZ985/patch-1
Grammar Issues
2 parents 93c8a22 + c7dd16d commit ab89001

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
SwiftSyntax is a set of Swift bindings for the
44
[libSyntax](https://github.com/apple/swift/tree/main/lib/Syntax) library. It
5-
allows for Swift tools to parse, inspect, generate, and transform Swift source
5+
allows Swift tools to parse, inspect, generate, and transform Swift source
66
code.
77

8-
Its API is designed for performance critical applications. It uses value types almost exclusively and aims to avoid existential conversions where possible.
8+
Its API is designed for performance-critical applications. It uses value types almost exclusively and aims to avoid existential conversions where possible.
99

1010
> Note: SwiftSyntax is still in development, and the API is not guaranteed to
1111
> be stable. It's subject to change without warning.
@@ -54,7 +54,7 @@ Then, import `SwiftSyntax` in your Swift code.
5454
$ export TOOLCHAINS=swift
5555
```
5656

57-
3. To make sure everything is setup correctly, check the result of `xcrun --find swift`. It should point inside the OSS toolchain.
57+
3. To make sure everything is set up correctly, check the result of `xcrun --find swift`. It should point inside the OSS toolchain.
5858

5959
4. Add this entry to the `Package.swift` manifest of your project:
6060

@@ -73,7 +73,7 @@ let package = Package(
7373
)
7474
```
7575

76-
Tags will be created for every nightly build in the form of `swift-DEVELOPMENT-SNAPSHOT-<DATE>`. Revision field
76+
Tags will be created for every nightly build in the form of `swift-DEVELOPMENT-SNAPSHOT-<DATE>`. The revision field
7777
should be specified with the intended tag.
7878

7979
Different from building SwiftSyntax from source, declaring SwiftSyntax as a SwiftPM dependency doesn't require
@@ -157,18 +157,18 @@ To build the `main` branch of SwiftSyntax, follow the following instructions:
157157
$ export TOOLCHAINS=swift
158158
```
159159

160-
4. To make sure everything is setup correctly, check the return statement of `xcrun --find swift`. It should point inside the latest installed trunk development toolchain. If it points inside an Xcode toolchain, check that you exported the `TOOLCHAINS` environment variable correctly. If it points inside a version specific toolchain (like Swift 5.0-dev), you'll need to remove that toolchain.
160+
4. To make sure everything is set up correctly, check the return statement of `xcrun --find swift`. It should point inside the latest installed trunk development toolchain. If it points inside an Xcode toolchain, check that you exported the `TOOLCHAINS` environment variable correctly. If it points inside a version-specific toolchain (like Swift 5.0-dev), you'll need to remove that toolchain.
161161
5. Run `swift-syntax/build-script.py`.
162162

163-
If, despite following those instructions, you get compiler errors, the Swift toolchain might be too old to contain recent changes in Swift's SwiftSyntaxParser C library. In that case, you'll have to build the compiler and SwiftSyntax together with the following command:
163+
If despite following those instructions, you get compiler errors, the Swift toolchain might be too old to contain recent changes in Swift's SwiftSyntaxParser C library. In that case, you'll have to build the compiler and SwiftSyntax together with the following command:
164164

165165
```
166166
$ swift/utils/build-script --swiftsyntax --swiftpm --llbuild
167167
```
168168

169169
Swift-CI will automatically run the code generation step whenever a new toolchain (development snapshot or release) is published. It should thus almost never be necessary to perform the above build yourself.
170170

171-
Afterwards, SwiftPM can also generate an Xcode project to develop SwiftSyntax by running `swift package generate-xcodeproj`.
171+
Afterward, SwiftPM can also generate an Xcode project to develop SwiftSyntax by running `swift package generate-xcodeproj`.
172172

173173
If you also want to run tests locally, read the section below as testing has additional requirements.
174174

@@ -181,7 +181,7 @@ swift/utils/build-script --swiftsyntax --swiftpm --llbuild -t --skip-test-cmark
181181
```
182182
This command will build SwiftSyntax and all its dependencies, tell the build script to run tests, but skip all tests but the SwiftSyntax tests.
183183

184-
Note that it is not currently supported to SwiftSyntax while building the Swift compiler using Xcode.
184+
Note that it is not currently supported by SwiftSyntax while building the Swift compiler using Xcode.
185185

186186
### CI Testing
187187

0 commit comments

Comments
 (0)