Merge pull request #2341 from rust-lang-nursery/steveklabnik-patch-1
Fix installation instructions to use rustup
This commit is contained in:
commit
8e6ee4a762
26
README.md
26
README.md
@ -21,31 +21,29 @@ to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
|
|||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
You must be using the latest nightly compiler toolchain.
|
Currently, you can use `rustfmt` on nightly and beta. Rust 1.24 stable will work,
|
||||||
|
but we're not quite there yet!
|
||||||
|
|
||||||
To install:
|
To install:
|
||||||
|
|
||||||
```
|
```
|
||||||
cargo install rustfmt-nightly
|
rustup component add rustfmt-preview --toolchain=nightly
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If `nightly` is your default toolchain, you can leave the `--toolchain` off.
|
||||||
|
|
||||||
to run on a cargo project in the current working directory:
|
to run on a cargo project in the current working directory:
|
||||||
|
|
||||||
```
|
```
|
||||||
cargo fmt
|
cargo +nightly fmt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If `nightly` is your default toolchain, you can leave off the `+nightly`.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```
|
```
|
||||||
cargo install rustfmt-nightly
|
rustup component add rustfmt-preview --toolchain=nightly
|
||||||
```
|
|
||||||
|
|
||||||
or if you're using [Rustup](https://www.rustup.rs/)
|
|
||||||
|
|
||||||
```
|
|
||||||
rustup update
|
|
||||||
rustup run nightly cargo install rustfmt-nightly
|
|
||||||
```
|
```
|
||||||
|
|
||||||
If you don't have a nightly toolchain, you can add it using rustup:
|
If you don't have a nightly toolchain, you can add it using rustup:
|
||||||
@ -63,12 +61,6 @@ rustup default nightly
|
|||||||
If you choose not to do that you'll have to run rustfmt using `rustup run ...`
|
If you choose not to do that you'll have to run rustfmt using `rustup run ...`
|
||||||
or by adding `+nightly` to the cargo invocation.
|
or by adding `+nightly` to the cargo invocation.
|
||||||
|
|
||||||
Usually cargo-fmt, which enables usage of Cargo subcommand `cargo fmt`, is
|
|
||||||
installed alongside rustfmt. To only install rustfmt run
|
|
||||||
|
|
||||||
```
|
|
||||||
cargo install --no-default-features rustfmt-nightly
|
|
||||||
```
|
|
||||||
## Installing from source
|
## Installing from source
|
||||||
|
|
||||||
To install from source, first checkout to the tag or branch you want to install, then issue
|
To install from source, first checkout to the tag or branch you want to install, then issue
|
||||||
|
Loading…
Reference in New Issue
Block a user