Brandon Mathis
3fc56112b5
Documentation formatting adjustments
2016-01-05 10:34:59 -05:00
practicalswift
0ae59b70d0
Use consistent indentation (four spaces) for code in Markdown.
2015-12-28 18:30:27 +01:00
Chris Lattner
6505377f02
Remove pointer to langref, it is more harmful than helpful.
2015-12-15 14:44:43 -08:00
Chris Lattner
39e2b0ccca
Merge pull request #471 from tommypacker/master
...
Update README.md
2015-12-15 14:43:00 -08:00
Dmitri Gribenko
37d457baad
README: add python to the dependencies to install
2015-12-13 00:50:18 -08:00
Tommy Yu
fe8c112714
Update README.md
...
Change sentence structure
2015-12-12 23:55:56 -06:00
Dylan Brown
7730b4921e
Update README.md
...
Update the README.md instructions for utils/update-checkout option. Should read `--clone-with-ssh`.
2015-12-11 17:19:50 +02:00
Dmitri Gribenko
6f221df1eb
README: simplify cloning instructions even further
...
... and re-add dropped text.
2015-12-10 17:03:11 -08:00
Brandon Mathis
dd68e72f70
Merge branch 'master' into feature/easier-install
2015-12-09 12:53:42 -05:00
Nikki Vergracht
b2b96595f5
Removed reference of non existing white paper.
2015-12-09 09:08:58 +01:00
Brandon Mathis
1b5ec13d74
Remove extraneous newline
2015-12-08 15:26:06 -05:00
Brandon Mathis
b0c4fbd242
Added option install with ssh param
2015-12-08 15:23:42 -05:00
Joshua Anderson
6a23544bfa
Update links to ninja git repository
...
It has been moved to an org (https://github.com/ninja-build ) and the old links simply redirect.
2015-12-07 19:26:11 -08:00
Jordan Rose
5e25990d08
Merge pull request #236 from codestergit/patch-9
...
Created HyperLink to sphinx-doc for easy access.
2015-12-05 11:46:02 -08:00
codestergit
7c2cea7405
Created HyperLink to sphinx in ReadMe.md for easy acess
2015-12-06 01:06:37 +05:30
Cameron Pulsford
6e377bdf0e
Corrects a README typo.
2015-12-05 13:36:52 -05:00
Greg Parker
b98d5ad2d6
Add github https command for ninja.
2015-12-05 06:09:27 -08:00
Ted Kremenek
da0bac1b90
Merge pull request #111 from codestergit/master
2015-12-04 13:52:28 -08:00
Chris Byatt
7586ee0041
Fix formatting of git commands
...
Alternately they could be marked as comments.
2015-12-04 19:04:17 +00:00
Zach Panzarino
9e8c458356
Grammatical Fix in Introduction
...
There is no need for the first "and" because it is a list of 3 items. This change improves the readability of the introduction.
2015-12-04 13:19:38 -05:00
Ted Kremenek
15428fb81b
Refine instructions for checking out sources.
...
For those looking for a direct way to check out sources without
needing to upload SSH keys to GitHub, provide checkouts using https.
For those who likely will be doing direct commits and have their
SSH keys uploaded to GitHub, provide URLs for cloning over SSH.
2015-12-03 21:06:51 -08:00
Lawrence Velázquez
31724574f1
Separate Homebrew/MacPorts instructions for CMake + Ninja
2015-12-03 23:27:20 -05:00
Lawrence Velázquez
12056374ba
Add command to install CMake + Ninja via MacPorts
2015-12-03 21:56:29 -05:00
codestergit
5850160ade
Added Swift logo
2015-12-04 05:51:05 +05:30
Terrence Katzenbaer
6e99e62d2a
Fix README header for subject agreement
...
This commit changes the "Develop Swift in Xcode" header to be
"Developing Swift in Xcode" to agree with the other headers
in the same file:
- "Getting Started"
- "Getting Sources"
- "Building Swift"
- "Testing Swift"
- "Contributing to Swift"
2015-12-03 15:59:08 -08:00
Steve Klabnik
f3e53b8bdb
Link to the code of conduct from the README.
2015-12-03 17:54:23 -05:00
Nico Weber
09f85c11e1
Update link to ninja homepage.
...
(The old link forwards to the new one these days.)
2015-12-03 15:22:14 -05:00
Arsen Gasparyan
acf933f7c5
Fixed typo
2015-12-03 21:56:16 +03:00
Kevin Yap
6492a47625
Minor README fixes
...
- Fix capitalization of "Swift".
- Use monospaced font for names of scripts.
- Omit root `swift` directory from paths.
- Split "whitepaper" into two words.
- Hyphenate "high-performance".
2015-12-03 10:44:54 -08:00
Steve Klabnik
5ba5baf11d
Remove extra / in git commands in README
...
This works, but is usually not how it's written. A command later in the
README was already using this style.
2015-12-03 12:25:35 -05:00
filipw
675102e239
Added a link to Testing.rst in the readme file
2015-12-03 11:53:41 -05:00
Tony Parker
32f8492936
Change recommended name of checkout directory for Foundation and XCTest
2015-11-30 08:09:45 -08:00
Doug Gregor
63f4f0804e
Add a "Contributing" section.
2015-11-28 23:28:39 -08:00
Philippe Hausler
4f4cfd7ac0
update related projects list to include Foundation and XCTest
...
This ensures proper naming when initial clones are made
Also ensure the list of required packages from apt-get include icu-devtools which is required for building CF on linux
2015-11-20 14:53:57 -08:00
David Farler
0c2cbb71f7
README: typo: stray 'the'
2015-11-16 17:36:41 -08:00
David Farler
406667eb12
README: Add Ubuntu 14.04 clang-3.6 dependency note
...
We have some C++14 build dependencies, so we need at least clang-3.6.
clang-3.6 on Ubuntu 14.04 LTS doesn't lay down /usr/bin/clang++ ->
/usr/bin/clang++-3.6 but the Swift frontend requires the clang driver
to be at that path.
2015-11-16 16:50:02 -08:00
David Farler
4defeb9300
Note libsqlite3-dev Linux build dependency
2015-11-13 14:22:55 -08:00
Ted Kremenek
e6e29cf1b5
Add 'pkg-config' to list of minimal dependencies. This was reported when building Swift on a minimal Ubuntu installation.
2015-11-13 09:35:33 -08:00
David Farler
68f90b085b
The Ninja package is called 'ninja-build' on Ubuntu
2015-11-11 13:09:06 -08:00
Chris Lattner
8726689d07
test commit
2015-11-11 11:10:21 -08:00
David Farler
726224a5e5
README: Clean up references to CMake and Ninja on OS X
...
- Add instructions for installing these on OS X
- Clean up the build-script section
2015-11-10 15:33:34 -08:00
Michael Gottesman
e9cade4379
Revert "Add to the README.md that when checking out llvm/clang from swift-{llvm,clang}, one needs to checkout the stable branches."
...
This reverts commit f7a29c7167 .
This is actually not necessary. I forgot that the default branch for
apple-{llvm/clang} is stable. Sorry for the noise!
2015-11-09 15:40:26 -06:00
Michael Gottesman
f7a29c7167
Add to the README.md that when checking out llvm/clang from swift-{llvm,clang}, one needs to checkout the stable branches.
2015-11-09 15:27:06 -06:00
David Farler
f944a147f2
README: Add libxml2-dev package dependency for Linux
...
This is used for XML validation in IDE tests.
2015-11-09 10:21:53 -08:00
David Farler
6f30afb7dd
Update README for configuring non-building Xcode projects
...
The README mentioned a flag that no longer exists. You still need
to build llvm-config in order to configure a non-building Xcode
project, so that flag was removed some time ago.
2015-11-03 09:51:40 -08:00
Ewa Matejska
f15f73cac3
Adjusting repo name.
2015-11-02 17:34:04 -08:00
Slava Pestov
49bac7823a
Fix repo name in README.md
2015-11-02 12:06:58 -08:00
David Farler
f9ad7ec397
Readme should suggest cloning to non-prefixed directories
...
<rdar://problem/23343989>
2015-10-31 00:19:25 -07:00
David Farler
0489fee055
Add Markdown version of the Open Source README
2015-10-31 00:19:25 -07:00