Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[beta] Backport book changes for rustup #38415

Merged
merged 3 commits into from
Dec 16, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mk/main.mk
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ CFG_RELEASE_NUM=1.14.0
# An optional number to put after the label, e.g. '.2' -> '-beta.2'
# NB Make sure it starts with a dot to conform to semver pre-release
# versions (section 9)
CFG_PRERELEASE_VERSION=.4
CFG_PRERELEASE_VERSION=.5

ifeq ($(CFG_RELEASE_CHANNEL),stable)
# This is the normal semver version string, e.g. "0.12.0", "0.12.0-nightly"
Expand Down
52 changes: 26 additions & 26 deletions src/doc/book/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,41 +111,40 @@ unofficial locations.
Note that this table can be expanded over time, this isn't the exhaustive set of
tier 3 platforms that will ever be!

## Installing on Linux or Mac
## Installing Rust

If we're on Linux or a Mac, 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 -sSf https://static.rust-lang.org/rustup.sh | sh
$ 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 ready to roll.
Rust is installed now. Great!
```

From here, press `y` for ‘yes’, and then follow the rest of the prompts.
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.

## Installing on Windows
For other installation options and information, visit the [install]
page of the Rust website.

If you're on Windows, please download the appropriate [installer][install-page].

[install-page]: https://www.rust-lang.org/install.html
[rustup-init.exe]: https://win.rustup.rs
[install]: https://www.rust-lang.org/install.html

## Uninstalling

Uninstalling Rust is as easy as installing it. On Linux or Mac, run
the uninstall script:
Uninstalling Rust is as easy as installing it:

```bash
$ sudo /usr/local/lib/rustlib/uninstall.sh
$ rustup self uninstall
```

If we used the Windows installer, we can re-run the `.msi` and it will give us
an uninstall option.

## Troubleshooting

If we've got Rust installed, we can open up a shell, and type this:
Expand All @@ -158,12 +157,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
Expand Down Expand Up @@ -193,9 +195,7 @@ resources include [the user’s forum][users] and [Stack Overflow][stackoverflow
[stackoverflow]: http://stackoverflow.com/questions/tagged/rust

This installer also installs a copy of the documentation locally, so we can
read it offline. On UNIX systems, `/usr/local/share/doc/rust` is the location.
On Windows, it's in a `share/doc` directory, inside the directory to which Rust
was installed.
read it offline. It's only a `rustup doc` away!

# Hello, world!

Expand Down