Skip to content

Commit ca287eb

Browse files
committed
auto merge of rust-lang#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 rust-lang#13578.
2 parents 6fad19e + b3fb258 commit ca287eb

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

src/doc/tutorial.md

+18-11
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,24 @@ they don't contain references to names that aren't actually defined.
5757
5858
# Getting started
5959

60-
> *Warning:* The tarball and installer links are for the most recent
61-
> release, not master. To use master, you **must** build from [git].
60+
There are two ways to install the Rust compiler: by building from source or
61+
by downloading prebuilt binaries or installers for your platform. The
62+
[install page][rust-install] contains links to download binaries for both
63+
the nightly build and the most current Rust major release. For Windows and
64+
OS X, the install page provides links to native installers.
6265

63-
The Rust compiler currently must be built from a [tarball] or [git], unless
64-
you are on Windows, in which case using the [installer][win-exe] is
65-
recommended. There is a list of community-maintained nightly builds and
66-
packages [on the wiki][wiki-packages].
66+
> *Note:* Windows users should read the detailed
67+
> [Getting started][wiki-start] notes on the wiki. Even when using
68+
> the binary installer, the Windows build requires a MinGW installation,
69+
> the precise details of which are not discussed here.
70+
71+
For Linux and OS X, the install page provides links to binary tarballs.
72+
To install the Rust compiler from the from a binary tarball, download
73+
the binary package, extract it, and execute the `install.sh` script in
74+
the root directory of the package.
75+
76+
To build the Rust compiler from source, you will need to obtain the source through
77+
[Git][git] or by downloading the source package from the [install page][rust-install].
6778

6879
Since the Rust compiler is written in Rust, it must be built by
6980
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:
7990
You may find that other platforms work, but these are our "tier 1"
8091
supported build environments that are most likely to work.
8192

82-
> *Note:* Windows users should read the detailed
83-
> [Getting started][wiki-start] notes on the wiki. Even when using
84-
> the binary installer, the Windows build requires a MinGW installation,
85-
> the precise details of which are not discussed here.
86-
8793
[wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
8894
[git]: https://github.com/mozilla/rust.git
95+
[rust-install]: http://www.rust-lang.org/install.html
8996

9097
To build from source you will also need the following prerequisite
9198
packages:

0 commit comments

Comments
 (0)