aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSimon Sapin <simon.sapin@exyr.org>2017-11-27 18:41:07 +0100
committerSimon Sapin <simon.sapin@exyr.org>2018-01-10 18:05:44 +0100
commitf2c398fd5c11362ae2918da7ee12a24e29e3cb6f (patch)
treee827b46596da4a7c4e127fa0af25e7e5612abeef
parent365a139716436bed8e6a178f4539e4a3d31099c4 (diff)
downloadservo-f2c398fd5c11362ae2918da7ee12a24e29e3cb6f.tar.gz
servo-f2c398fd5c11362ae2918da7ee12a24e29e3cb6f.zip
Add rustup.rs instructions in README
-rw-r--r--README.md34
1 files changed, 29 insertions, 5 deletions
diff --git a/README.md b/README.md
index 0fafbac6ed4..3c8e16e3a84 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,32 @@ Visit the [Servo Project page](https://servo.org/) for news and guides.
## Setting up your environment
+### Rustup.rs
+
+Building servo requires [rustup](https://rustup.rs/), version 1.8.0 or more recent.
+If you have an older version, run `rustup self update`.
+
+To install on Windows, download and run [`rustup-init.exe`](https://win.rustup.rs/)
+then follow the onscreen instructions.
+
+To install on other systems, run:
+
+```sh
+curl https://sh.rustup.rs -sSf | sh
+```
+
+This will also download the current stable version of Rust, which Servo won’t use.
+To skip that step, run instead:
+
+```
+curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain none
+```
+
+See also [Other installation methods](
+https://github.com/rust-lang-nursery/rustup.rs/#other-installation-methods)
+
+### Other dependencies
+
Please select your operating system:
* [OS X](#os-x)
* [Debian-based Linuxes](#on-debian-based-linuxes)
@@ -152,11 +178,9 @@ Pre-installed Android tools are needed. See wiki for
## The Rust compiler
-Servo's build system automatically downloads a Rust compiler to build itself.
-This is normally a specific revision of Rust upstream, but sometimes has a
-backported patch or two.
-If you'd like to know which nightly build of Rust we use, see
-[`rust-toolchain`](https://github.com/servo/servo/blob/master/rust-toolchain).
+Servo's build system uses rustup.rs to automatically download a Rust compiler.
+This is a specific version of Rust Nightly determined by the
+[`rust-toolchain`](https://github.com/servo/servo/blob/master/rust-toolchain) file.
## Building