Skip to content

Commit e1ece57

Browse files
xwuCodaFi
authored andcommitted
Update README.md (#10946)
Link to development dependencies and reword text in order to encourage installation of all prerequisites before attempting to build. Incidentally fix punctuation. Conform line-wrapping to prevailing standards throughout the document.
1 parent b37b3ba commit e1ece57

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ To read the documentation, start by installing the
3030
`easy_install -U Sphinx`
3131

3232
Once complete, you can build the Swift documentation by changing directory into
33-
[docs](https://github.com/apple/swift/tree/master/docs) and typing `make`. This compiles the `.rst` files in the [docs](https://github.com/apple/swift/tree/master/docs) directory
34-
into HTML in the `docs/_build/html` directory.
33+
[docs](https://github.com/apple/swift/tree/master/docs) and typing `make`. This
34+
compiles the `.rst` files in the [docs](https://github.com/apple/swift/tree/master/docs)
35+
directory into HTML in the `docs/_build/html` directory.
3536

3637
Many of the docs are out of date, but you can see some historical design
3738
documents in the `docs` directory.
@@ -56,7 +57,8 @@ supported host development operating systems.
5657

5758
For macOS, you need [Xcode 9.0 beta 2](https://developer.apple.com/xcode/downloads/).
5859

59-
For Ubuntu, you'll need the following development dependencies:
60+
<a name="linux-dependencies"></a>For Ubuntu, you'll need the following
61+
development dependencies:
6062

6163
sudo apt-get install git cmake ninja-build clang python uuid-dev libicu-dev icu-devtools libbsd-dev libedit-dev libxml2-dev libsqlite3-dev swig libpython-dev libncurses5-dev pkg-config libblocksruntime-dev libcurl4-openssl-dev autoconf libtool systemtap-sdt-dev tzdata
6264

@@ -99,9 +101,9 @@ command line tools to your `PATH`:
99101

100102
export PATH=/Applications/CMake.app/Contents/bin:$PATH
101103

102-
On Linux, if the CMake package was not downloaded in the development dependencies you can download and
103-
install the CMake package using the following command:
104-
104+
On Linux, if you have not already installed Swift's [development
105+
dependencies](#linux-dependencies), you can download and install the CMake
106+
package separately using the following command:
105107

106108
sudo apt-get install cmake
107109

@@ -170,13 +172,14 @@ See [docs/Testing.md](docs/Testing.md).
170172

171173
## Contributing to Swift
172174

173-
Contributions to Swift are welcomed and encouraged! Please see the [Contributing to Swift guide](https://swift.org/contributing/).
175+
Contributions to Swift are welcomed and encouraged! Please see the
176+
[Contributing to Swift guide](https://swift.org/contributing/).
174177

175-
To be a truly great community, [Swift.org](https://swift.org/) needs to welcome developers from all
176-
walks of life, with different backgrounds, and with a wide range of experience.
177-
A diverse and friendly community will have more great ideas, more unique
178-
perspectives, and produce more great code. We will work diligently to make the
179-
Swift community welcoming to everyone.
178+
To be a truly great community, [Swift.org](https://swift.org/) needs to welcome
179+
developers from all walks of life, with different backgrounds, and with a wide
180+
range of experience. A diverse and friendly community will have more great
181+
ideas, more unique perspectives, and produce more great code. We will work
182+
diligently to make the Swift community welcoming to everyone.
180183

181184
To give clarity of what is expected of our members, Swift has adopted the
182185
code of conduct defined by the Contributor Covenant. This document is used

0 commit comments

Comments
 (0)