Use types rather than strings

[rust.git] / README.md

diff --git a/README.md b/README.md
index 5bd3981260e15ad08d53137eb552e7f3bd9ef4f4..41eacdba1a4a81f0a49e0c48688ac0c6a6553716 100644 (file)
--- a/README.md
+++ b/README.md
@@ -35,44 +35,46 @@ Table of contents:
 Since this is a tool for helping the developer of a library or application
 write better code, it is recommended not to include Clippy as a hard dependency.
 Options include using it as an optional dependency, as a cargo subcommand, or
-as an included feature during build. All of these options are detailed below.
+as an included feature during build. These options are detailed below.
 
-As a general rule Clippy will only work with the *latest* Rust nightly for now.
+### As a cargo subcommand (`cargo clippy`)
 
-To install Rust nightly, the recommended way is to use [rustup](https://rustup.rs/):
+One way to use Clippy is by installing Clippy through rustup as a cargo
+subcommand.
 
-```terminal
-rustup install nightly
-```
+#### Step 1: Install rustup
 
-### As a cargo subcommand (`cargo clippy`)
+You can install [rustup](http://rustup.rs/) on supported platforms. This will help
+us install clippy and its dependencies.
 
-One way to use Clippy is by installing Clippy through cargo as a cargo
-subcommand.
+If you already have rustup installed, update to ensure you have the latest
+rustup and compiler:
 
 ```terminal
-cargo +nightly install clippy
+rustup update
 ```
 
-(The `+nightly` is not necessary if your default `rustup` install is nightly)
+#### Step 2: Install nightly toolchain
 
-Now you can run Clippy by invoking `cargo +nightly clippy`.
+Rustup integration is still new, you will need a relatively new nightly (2018-07-15 or later).
 
-To update the subcommand together with the latest nightly use the [rust-update](rust-update) script or run:
+To install Rust nightly with [rustup](https://rustup.rs/):
 
 ```terminal
-rustup update nightly
-cargo +nightly install --force clippy
+rustup install nightly
 ```
 
-In case you are not using rustup, you need to set the environment flag
-`SYSROOT` during installation so Clippy knows where to find `librustc` and
-similar crates.
+#### Step 3: Install clippy
+
+Once you have rustup and the nightly toolchain installed, run the following command:
 
 ```terminal
-SYSROOT=/path/to/rustc/sysroot cargo install clippy
+rustup component add clippy-preview --toolchain=nightly
 ```
 
+Now you can run Clippy by invoking `cargo +nightly clippy`. If nightly is your
+default toolchain in rustup, `cargo clippy` will work fine.
+
 ### Running Clippy from the command line without installing it
 
 To have cargo compile your crate with Clippy without Clippy installation