Skip to content

Commit

Permalink
Update tutorial, see issue #13578
Browse files Browse the repository at this point in the history
  • Loading branch information
swgillespie committed May 26, 2014
1 parent 3d63370 commit b3fb258
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions src/doc/tutorial.md
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -1710,7 +1717,7 @@ it's possible to use *dynamic* mutability via types like `std::cell::Cell` where
via dynamic checks and can fail at runtime.

The `Rc` and `Gc` types are not sendable, so they cannot be used to share memory between tasks. Safe
immutable and mutable shared memory is provided by the `extra::arc` module.
immutable and mutable shared memory is provided by the `sync::arc` module.

# Closures

Expand Down

5 comments on commit b3fb258

@bors
Copy link
Contributor

@bors bors commented on b3fb258 May 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from alexcrichton
at swgillespie@b3fb258

@bors
Copy link
Contributor

@bors bors commented on b3fb258 May 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging swgillespie/rust/swgillespie-tutorial = b3fb258 into auto

@bors
Copy link
Contributor

@bors bors commented on b3fb258 May 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

swgillespie/rust/swgillespie-tutorial = b3fb258 merged ok, testing candidate = ca287eb

@bors
Copy link
Contributor

@bors bors commented on b3fb258 May 26, 2014

@bors
Copy link
Contributor

@bors bors commented on b3fb258 May 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = ca287eb

Please sign in to comment.