X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=8f498240802c0a67a257612bd37ad7c70e905656;hb=9c1761d0ab04681ef65c6e589c7c663d917b5eb7;hp=ed3a353f0e689ee5439f3efcf72352797e550b62;hpb=695cb9fc2b1bb98a9affac3887806925f962c0aa;p=rust.git diff --git a/README.md b/README.md index ed3a353f0e6..8f498240802 100644 --- a/README.md +++ b/README.md @@ -5,63 +5,62 @@ documentation. ## Quick Start -### Windows - -1. Download and use the [installer][win-exe]. +1. Download a [binary installer][installer] for your platform. 2. Read the [tutorial]. -2. Enjoy! +3. Enjoy! -> ***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. +> ***Note:*** Windows users can read the detailed +> [getting started][wiki-start] notes on the wiki. +[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-exe]: http://static.rust-lang.org/dist/rust-0.8-install.exe +[win-wiki]: https://github.com/mozilla/rust/wiki/Using-Rust-on-Windows + +## Building from Source -### Linux / OS X +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: -1. Install the prerequisites (if not already installed) - * 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 -2. Download and build Rust You can either download a [tarball] or build directly from the [repo]. - + To build from the [tarball] do: - - $ curl -O http://static.rust-lang.org/dist/rust-0.8.tar.gz - $ tar -xzf rust-0.8.tar.gz - $ cd rust-0.8 - + + $ curl -O http://static.rust-lang.org/dist/rust-nightly.tar.gz + $ tar -xzf rust-nightly.tar.gz + $ cd rust-nightly + Or to build from the [repo] do: $ git clone https://github.com/mozilla/rust.git $ cd rust Now that you have Rust's source code, you can configure and build it: - + $ ./configure $ make && make install - - 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. + + > ***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. 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 + `/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-0.8.tar.gz -[tutorial]: http://static.rust-lang.org/doc/0.8/tutorial.html +[tarball]: http://static.rust-lang.org/dist/rust-nightly.tar.gz +[tutorial]: http://static.rust-lang.org/doc/master/tutorial.html ## Notes @@ -72,21 +71,20 @@ fetch snapshots, and an OS that can execute the available snapshot binaries. Snapshot binaries are currently built and tested on several platforms: -* 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 +* 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 "tier 1" +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.8G of RAM to build without swapping; if it hits +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 lots more documentation in the [wiki]. +There is a lot more documentation in the [wiki]. [wiki]: https://github.com/mozilla/rust/wiki - ## License Rust is primarily distributed under the terms of both the MIT license @@ -94,4 +92,3 @@ and the Apache License (Version 2.0), with portions covered by various BSD-like licenses. See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details. -