Skip to content

Removed reference of non existing white paper. #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 9, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,35 @@ and frameworks, and is memory safe (by default).
Although inspired by Objective-C and many other languages, Swift is not itself a
C-derived language. As a complete and independent language, Swift packages core
features like flow control, data structures, and functions, with high-level
constructs like objects, protocols, closures, and generics. Swift embraces
constructs like objects, protocols, closures, and generics. Swift embraces
modules, eliminating the need for headers and the code duplication they entail.


## Documentation

To read the documentation, start by installing the
[Sphinx](http://sphinx-doc.org) documentation generator tool (just run
To read the documentation, start by installing the
[Sphinx](http://sphinx-doc.org) documentation generator tool (just run
`easy_install -U Sphinx` from the command line and you're good to go). Once you
have that, you can build the Swift documentation by going into `docs` and
typing `make`. This compiles the `.rst` files in the `docs` directory into
have that, you can build the Swift documentation by going into `docs` and
typing `make`. This compiles the `.rst` files in the `docs` directory into
HTML in the `docs/_build/html` directory.

Once built, the best place to start is with the Swift white paper, which gives a
tour of the language (in `docs/_build/html/whitepaper/index.html`).
Another potentially useful document is `docs/LangRef`, which gives a low level
A potentially useful document to start is `docs/LangRef`, which gives a low level
tour of how the language works from the implementation perspective.

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

Another source of documentation is the standard library itself, located in
`stdlib`. Much of the language is actually implemented in the library
`stdlib`. Much of the language is actually implemented in the library
(including `Int`), and the standard library gives some examples of what can be
expressed today.


## Getting Started

These instructions give the most direct path to a working Swift
development environment. Options for doing things differently are
development environment. Options for doing things differently are
discussed below.


Expand Down Expand Up @@ -80,7 +78,7 @@ For those checking out sources as read-only:
git clone https://github.com/apple/swift-corelibs-foundation.git

For those who plan on regularly making direct commits, cloning over
SSH may provide a better experience (which requires uploading
SSH may provide a better experience (which requires uploading
SSH keys to GitHub):

git clone [email protected]:apple/swift.git swift
Expand Down