about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2016-12-02 01:17:32 +0000
committerBrian Anderson <banderson@mozilla.com>2016-12-16 21:18:44 +0000
commit7550e321462e9a0590ded68c2984ddc645b877fb (patch)
treee907f811a59c40eaccbc11dd7b9db37a27d10872
parent38cb687075867decd2bfd5630d3b83aa50b47f73 (diff)
downloadrust-7550e321462e9a0590ded68c2984ddc645b877fb.tar.gz
rust-7550e321462e9a0590ded68c2984ddc645b877fb.zip
Update book for rustup
-rw-r--r--src/doc/book/getting-started.md32
1 files changed, 23 insertions, 9 deletions
diff --git a/src/doc/book/getting-started.md b/src/doc/book/getting-started.md
index 1884f216e94..5aae693ad6b 100644
--- a/src/doc/book/getting-started.md
+++ b/src/doc/book/getting-started.md
@@ -26,19 +26,30 @@ see the website][platform-support].
 
 ## Installing Rust
 
-All we need to do is open a terminal and type this:
+All you need to do on Unix systems like Linux and macOS is open a
+terminal and type this:
 
 ```bash
 $ curl https://sh.rustup.rs -sSf | sh
 ```
 
-This will download a script, and start the installation. If it all goes well,
-you’ll see this appear:
+It will download a script, and start the installation. If everything
+goes well, you’ll see this appear:
 
 ```text
 Rust is installed now. Great! 
 ```
 
+Installing on Windows is nearly as easy: download and run
+[rustup-init.exe]. It will start the installation in a console and
+present the above message on success.
+
+For other installation options and information, visit the [install]
+page of the Rust website.
+
+[rustup-init.exe]: https://win.rustup.rs
+[install]: https://www.rust-lang.org/install.html
+
 ## Uninstalling
 
 Uninstalling Rust is as easy as installing it:
@@ -59,12 +70,15 @@ You should see the version number, commit hash, and commit date.
 
 If you do, Rust has been installed successfully! Congrats!
 
-If you don't and you're on Windows, check that Rust is in your %PATH% system
-variable: `$ echo %PATH%`. If it isn't, run the installer again, select "Change"
-on the "Change, repair, or remove installation" page and ensure "Add to PATH" is
-installed on the local hard drive.  If you need to configure your path manually,
-you can find the Rust executables in a directory like
-`"C:\Program Files\Rust stable GNU 1.x\bin"`.
+If you don't, that probably means that the `PATH` environment variable
+doesn't include Cargo's binary directory, `~/.cargo/bin` on Unix, or
+`%USERPROFILE%\.cargo\bin` on Windows. This is the directory where
+Rust development tools live, and most Rust developers keep it in their
+`PATH` environment variable, which makes it possible to run `rustc` on
+the command line. Due to differences in operating systems, command
+shells, and bugs in installation, you may need to restart your shell,
+log out of the system, or configure `PATH` manually as appropriate for
+your operating environment.
 
 Rust does not do its own linking, and so you’ll need to have a linker
 installed. Doing so will depend on your specific system. For