Skip to content

Commit 9e657ee

Browse files
committed
[xcodegen] Update README
Make it a bit clearer that `utils/generate-xcode` is a convenience for the `swift-xcodegen` script in this directory.
1 parent 34c417d commit 9e657ee

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

utils/swift-xcodegen/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ This script is primarily focussed on providing a good editor experience for work
1111

1212
## Running
1313

14-
Run as:
14+
You can run using either `utils/generate-xcode` or the `swift-xcodegen` script in this directory; the former is just a convenience for the latter. The basic invocation is:
1515

16+
```sh
17+
./swift-xcodegen <build dir>
1618
```
17-
./swift-xcodegen <path to Ninja build directory>
18-
```
1919

20-
An Xcode project will be created in the grandparent directory (i.e `build/../Swift.xcodeproj`). Projects for LLVM, LLDB, and Clang may also be created by passing `--llvm`, `--lldb`, and `--clang` respectively. Workspaces of useful combinations will also be created (e.g Swift+LLVM, Clang+LLVM).
20+
where `<build dir>` is the path to the build directory e.g `build/Ninja-RelWithDebInfoAssert`. This will by default create a `Swift.xcodeproj` in the parent directory (next to the `build` directory). Projects for LLVM, LLDB, and Clang may also be created by passing `--llvm`, `--lldb`, and `--clang` respectively. Workspaces of useful combinations will also be created (e.g Swift+LLVM, Clang+LLVM).
21+
22+
For the full set of options, see the [Command usage](#command-usage) below.
2123

2224
An `ALL` meta-target is created that depends on all the targets in the given project or workspace. A scheme for this target is automatically generated too (and automatic scheme generation is disabled). You can manually add individual schemes for targets you're interested in. Note however that Clang targets do not currently have dependency information.
2325

0 commit comments

Comments
 (0)