This is a compiler for Rust, including standard libraries, tools and
documentation.
+## Quick Start
-## Installation
+1. Download a [binary installer][installer] for your platform.
+2. Read the [tutorial].
+3. Enjoy!
-The Rust compiler currently must be built from a [tarball], unless you
-are on Windows, in which case using the [installer][win-exe] is
-recommended.
+> ***Note:*** Windows users can read the detailed
+> [getting started][wiki-start] notes on the wiki.
-Since the Rust compiler is written in Rust, it must be built by
-a precompiled "snapshot" version of itself (made in an earlier state
-of development). As such, source builds require a connection to
-the Internet, to fetch snapshots, and an OS that can execute the
-available snapshot binaries.
+[installer]: http://www.rust-lang.org/install.html
+[tutorial]: http://static.rust-lang.org/doc/tutorial.html
+[wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
+[win-wiki]: https://github.com/mozilla/rust/wiki/Using-Rust-on-Windows
-Snapshot binaries are currently built and tested on several platforms:
+## Building from Source
-* Windows (7, Server 2008 R2), x86 only
-* Linux (various distributions), x86 and x86-64
-* OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64
+1. Make sure you have installed the dependencies:
+ * `g++` 4.4 or `clang++` 3.x
+ * `python` 2.6 or later (but not 3.x)
+ * `perl` 5.0 or later
+ * GNU `make` 3.81 or later
+ * `curl`
+ * `git`
+2. Download and build Rust:
-You may find that other platforms work, but these are our "tier 1"
-supported build environments that are most likely to work.
+ You can either download a [tarball] or build directly from the [repo].
-> ***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.
+ To build from the [tarball] do:
-To build from source you will also need the following prerequisite
-packages:
+ $ curl -O http://static.rust-lang.org/dist/rust-nightly.tar.gz
+ $ tar -xzf rust-nightly.tar.gz
+ $ cd rust-nightly
-* g++ 4.4 or clang++ 3.x
-* python 2.6 or later (but not 3.x)
-* perl 5.0 or later
-* gnu make 3.81 or later
-* curl
+ Or to build from the [repo] do:
-Assuming you're on a relatively modern *nix system and have met the
-prerequisites, something along these lines should work.
+ $ git clone https://github.com/mozilla/rust.git
+ $ cd rust
- $ curl -O http://static.rust-lang.org/dist/rust-0.6.tar.gz
- $ tar -xzf rust-0.6.tar.gz
- $ cd rust-0.6
- $ ./configure
- $ make && make install
+ Now that you have Rust's source code, you can configure and build it:
-You may need to use `sudo make install` if you do not normally have
-permission to modify the destination directory. The install locations
-can be adjusted by passing a `--prefix` argument to
-`configure`. Various other options are also supported, pass `--help`
-for more information on them.
+ $ ./configure
+ $ make && make install
-When complete, `make install` will place several programs into
-`/usr/local/bin`: `rustc`, the Rust compiler; `rustdoc`, the
-API-documentation tool, and `rustpkg`, the Rust package manager and build system.
+ > ***Note:*** You may need to use `sudo make install` if you do not normally have
+ > permission to modify the destination directory. The install locations can
+ > be adjusted by passing a `--prefix` argument to `configure`. Various other
+ > options are also supported, pass `--help` for more information on them.
-[wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
-[tarball]: http://static.rust-lang.org/dist/rust-0.6.tar.gz
-[win-exe]: http://static.rust-lang.org/dist/rust-0.6-install.exe
+ When complete, `make install` will place several programs into
+ `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
+ API-documentation tool.
+ system.
+3. Read the [tutorial].
+4. Enjoy!
+
+[repo]: https://github.com/mozilla/rust
+[tarball]: http://static.rust-lang.org/dist/rust-nightly.tar.gz
+[tutorial]: http://static.rust-lang.org/doc/master/tutorial.html
+
+## Notes
+
+Since the Rust compiler is written in Rust, it must be built by a
+precompiled "snapshot" version of itself (made in an earlier state of
+development). As such, source builds require a connection to the Internet, to
+fetch snapshots, and an OS that can execute the available snapshot binaries.
+
+Snapshot binaries are currently built and tested on several platforms:
+* Windows (7, 8, Server 2008 R2), x86 only
+* Linux (2.6.18 or later, various distributions), x86 and x86-64
+* OSX 10.7 (Lion) or greater, x86 and x86-64
+
+You may find that other platforms work, but these are our officially
+supported build environments that are most likely to work.
+
+Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
+swap, it will take a very long time to build.
+
+There is a lot more documentation in the [wiki].
+
+[wiki]: https://github.com/mozilla/rust/wiki
## License
BSD-like licenses.
See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.
-
-## More help
-
-The [tutorial] is a good starting point.
-
-[tutorial]: http://static.rust-lang.org/doc/tutorial.html
projects / rust.git / blobdiff