diff options
| author | bors <bors@rust-lang.org> | 2014-05-26 11:51:27 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2014-05-26 11:51:27 -0700 |
| commit | ca287ebc645a0748869948b8217a06ecbf8afb77 (patch) | |
| tree | d8bf9c9e2d772db691f74dc5e4063b603cdd1265 | |
| parent | 6fad19e16b2770c6641d7a457415d4c4c65e1f8d (diff) | |
| parent | b3fb258406289cb7f59fdd9619d419bb9749a2a0 (diff) | |
| download | rust-ca287ebc645a0748869948b8217a06ecbf8afb77.tar.gz rust-ca287ebc645a0748869948b8217a06ecbf8afb77.zip | |
auto merge of #14374 : swgillespie/rust/swgillespie-tutorial, r=alexcrichton
The current tutorial says that the only way to get master is to build from source, which isn't true anymore - nightly binaries and an installer for Mac OS X are now available at the install page: http://www.rust-lang.org/install.html . Feedback very much welcome! Addresses issue #13578.
| -rw-r--r-- | src/doc/tutorial.md | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/src/doc/tutorial.md b/src/doc/tutorial.md index 981c8a37085..4b15e82ea3b 100644 --- a/src/doc/tutorial.md +++ b/src/doc/tutorial.md @@ -57,13 +57,24 @@ they don't contain references to names that aren't actually defined. # Getting started -> *Warning:* The tarball and installer links are for the most recent -> release, not master. To use master, you **must** build from [git]. +There are two ways to install the Rust compiler: by building from source or +by downloading prebuilt binaries or installers for your platform. The +[install page][rust-install] contains links to download binaries for both +the nightly build and the most current Rust major release. For Windows and +OS X, the install page provides links to native installers. -The Rust compiler currently must be built from a [tarball] or [git], unless -you are on Windows, in which case using the [installer][win-exe] is -recommended. There is a list of community-maintained nightly builds and -packages [on the wiki][wiki-packages]. +> *Note:* Windows users should read the detailed +> [Getting started][wiki-start] notes on the wiki. Even when using +> the binary installer, the Windows build requires a MinGW installation, +> the precise details of which are not discussed here. + +For Linux and OS X, the install page provides links to binary tarballs. +To install the Rust compiler from the from a binary tarball, download +the binary package, extract it, and execute the `install.sh` script in +the root directory of the package. + +To build the Rust compiler from source, you will need to obtain the source through +[Git][git] or by downloading the source package from the [install page][rust-install]. Since the Rust compiler is written in Rust, it must be built by a precompiled "snapshot" version of itself (made in an earlier state @@ -79,13 +90,9 @@ Snapshot binaries are currently built and tested on several platforms: You may find that other platforms work, but these are our "tier 1" supported build environments that are most likely to work. -> *Note:* Windows users should read the detailed -> [Getting started][wiki-start] notes on the wiki. Even when using -> the binary installer, the Windows build requires a MinGW installation, -> the precise details of which are not discussed here. - [wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust [git]: https://github.com/mozilla/rust.git +[rust-install]: http://www.rust-lang.org/install.html To build from source you will also need the following prerequisite packages: |