2
2
3
3
** Welcome to Swift!**
4
4
5
- Swift is a high performance systems programming language. It has a clean
5
+ Swift is a high- performance systems programming language. It has a clean
6
6
and modern syntax, and offers seamless access to existing C and Objective-C code
7
7
and frameworks, and is memory safe (by default).
8
8
@@ -18,20 +18,20 @@ modules, eliminating the need for headers and the code duplication they entail.
18
18
To read the documentation, start by installing the Sphinx documentation
19
19
generator tool (http://sphinx-doc.org , just run ` easy_install -U Sphinx ` from
20
20
the command line and you're good to go). Once you have that, you can build the
21
- swift documentation by going into ` swift/ docs` and typing ` make ` . This compiles
22
- the ' rst' files in the docs directory into HTML in the ` swift/ docs/_build/html`
21
+ Swift documentation by going into ` docs ` and typing ` make ` . This compiles
22
+ the ` . rst` files in the ` docs ` directory into HTML in the ` docs/_build/html `
23
23
directory.
24
24
25
- Once built, the best place to start is with the swift whitepaper , which gives a
26
- tour of the language (in ` swift/ docs/_build/html/whitepaper/index.html` ).
25
+ Once built, the best place to start is with the Swift white paper , which gives a
26
+ tour of the language (in ` docs/_build/html/whitepaper/index.html ` ).
27
27
Another potentially useful document is ` docs/LangRef ` , which gives a low level
28
28
tour of how the language works from the implementation perspective.
29
29
30
30
Many of the docs are out of date, but you can see some historical design
31
31
documents in the ` docs ` directory.
32
32
33
- Another source of documentation is the standard library itself, located at
34
- ` swift/ stdlib` . Much of the language is actually implemented in the library
33
+ Another source of documentation is the standard library itself, located in
34
+ ` stdlib ` . Much of the language is actually implemented in the library
35
35
(including ` Int ` ), and the standard library gives some examples of what can be
36
36
expressed today.
37
37
@@ -107,14 +107,14 @@ supports presets which you can define for common combinations of build options.
107
107
108
108
To find out more:
109
109
110
- swift/ utils/build-script -h
110
+ utils/build-script -h
111
111
112
112
Note: Arguments after "--" above are forwarded to ` build-script-impl ` , which is
113
113
the ultimate shell script that invokes the actual build and test commands.
114
114
115
115
A basic command to build Swift and run basic tests with Ninja:
116
116
117
- swift/ utils/build-script -t
117
+ utils/build-script -t
118
118
119
119
## Develop Swift in Xcode
120
120
@@ -124,13 +124,13 @@ to build for other SDKs but still use Xcode, once you've built Swift using Ninja
124
124
or one of the other supported CMake generators, you can set up an IDE-only Xcode
125
125
environment using the build-script's ` -X ` flag:
126
126
127
- swift/ utils/build-script -X --skip-build -- --reconfigure
127
+ utils/build-script -X --skip-build -- --reconfigure
128
128
129
- The ` --skip-build ` flag tells build-script to only generate the project,
129
+ The ` --skip-build ` flag tells ` build-script ` to only generate the project,
130
130
not build it in its entirety. A bare minimum of LLVM tools will build in order
131
131
to configure the Xcode projects.
132
132
133
- The ` --reconfigure ` flag tells build-script-impl to run the CMake configuration
133
+ The ` --reconfigure ` flag tells ` build-script-impl ` to run the CMake configuration
134
134
step even if there is a cached configuration. As you develop in Xcode, you may
135
135
need to rerun this from time to time to refresh your generated Xcode project,
136
136
picking up new targets, file removals, or file additions.
0 commit comments