Skip to content

Commit 4f03e03

Browse files
committed
Update the getting started instructions
1 parent 10e0e56 commit 4f03e03

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

Docs/GettingStarted.md

+22-13
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,29 @@ Testing steps:
2323

2424
You will need:
2525

26-
* A supported distribution of Linux. At this time, we only support [Ubuntu 15.10](http://www.ubuntu.com).
27-
* A recent version of the clang compiler and swiftc compiler. _**TODO**_: Instructions on how to get this from github.
28-
* Some additional tools and libraries:
29-
* `sudo apt-get install ninja`
30-
* `sudo apt-get install libicu-dev`
31-
* `sudo apt-get install icu-devtools`
26+
* A supported distribution of Linux. At this time, we support [Ubuntu 14.04 and Ubuntu 15.10](http://www.ubuntu.com).
3227

33-
Build steps:
28+
To get started, follow the instructions on how to [build Swift](https://github.com/apple/swift#building-swift). Foundation requires use of the version of `swiftc` and `clang` built with the overall project.
3429

35-
0. `cd Foundation`
36-
0. `./configure debug` - This runs a python configuration script, and produces `build.ninja` for building a debug version of Foundation.
37-
0. `ninja` - This builds Foundation
30+
The default build script does not include Foundation. To build Foundation as well, pass `--foundation` to the build script.
3831

39-
Testing steps:
32+
```
33+
swift/utils/build-script --foundation -t
34+
```
35+
36+
This will build and run the Foundation tests.
37+
38+
After the complete Swift build has finished, you can iterate quickly on Foundation itself by simply invoking `ninja` in the Foundation directory.
39+
40+
```
41+
cd Foundation
42+
ninja
43+
```
44+
45+
This will build Foundation. To build and run the tests, use the `test` target:
46+
47+
```
48+
ninja test
49+
```
4050

41-
0. `ninja TestFoundation` - This builds the TestFoundation executable.
42-
0. `LD_LIBRARY_PATH=Build/Foundation ./Build/TestFoundation/TestFoundation` - Run the new TestFoundation executable against the Foundation you just built.
51+
The script will also output some help on how to run the tests under the debugger. The exact library path to use will depend on how Foundation itself was configured.

0 commit comments

Comments
 (0)