Skip to content

Commit 166ba55

Browse files
committed
Merge pull request #68 from iKevinY/patch-1
Minor README fixes
2 parents 9b5593a + 6492a47 commit 166ba55

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

Diff for: README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Welcome to Swift!**
44

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
66
and modern syntax, and offers seamless access to existing C and Objective-C code
77
and frameworks, and is memory safe (by default).
88

@@ -18,20 +18,20 @@ modules, eliminating the need for headers and the code duplication they entail.
1818
To read the documentation, start by installing the Sphinx documentation
1919
generator tool (http://sphinx-doc.org, just run `easy_install -U Sphinx` from
2020
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`
2323
directory.
2424

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`).
2727
Another potentially useful document is `docs/LangRef`, which gives a low level
2828
tour of how the language works from the implementation perspective.
2929

3030
Many of the docs are out of date, but you can see some historical design
3131
documents in the `docs` directory.
3232

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
3535
(including `Int`), and the standard library gives some examples of what can be
3636
expressed today.
3737

@@ -107,14 +107,14 @@ supports presets which you can define for common combinations of build options.
107107

108108
To find out more:
109109

110-
swift/utils/build-script -h
110+
utils/build-script -h
111111

112112
Note: Arguments after "--" above are forwarded to `build-script-impl`, which is
113113
the ultimate shell script that invokes the actual build and test commands.
114114

115115
A basic command to build Swift and run basic tests with Ninja:
116116

117-
swift/utils/build-script -t
117+
utils/build-script -t
118118

119119
## Develop Swift in Xcode
120120

@@ -124,13 +124,13 @@ to build for other SDKs but still use Xcode, once you've built Swift using Ninja
124124
or one of the other supported CMake generators, you can set up an IDE-only Xcode
125125
environment using the build-script's `-X` flag:
126126

127-
swift/utils/build-script -X --skip-build -- --reconfigure
127+
utils/build-script -X --skip-build -- --reconfigure
128128

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,
130130
not build it in its entirety. A bare minimum of LLVM tools will build in order
131131
to configure the Xcode projects.
132132

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
134134
step even if there is a cached configuration. As you develop in Xcode, you may
135135
need to rerun this from time to time to refresh your generated Xcode project,
136136
picking up new targets, file removals, or file additions.

0 commit comments

Comments
 (0)