squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Merge pull request #2341 from rust-lang-nursery/steveklabnik-patch-1

Browse source 
Fix installation instructions to use rustup
This commit is contained in:
Seiichi Uchida 2018-01-21 15:26:31 +09:00 committed by GitHub
commit 8e6ee4a762
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -21,31 +21,29 @@ to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
## 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:
```
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:
```
cargo fmt
cargo +nightly fmt
```
If `nightly` is your default toolchain, you can leave off the `+nightly`.
## Installation
```
cargo install rustfmt-nightly
```
or if you're using [Rustup](https://www.rustup.rs/)
```
rustup update
rustup run nightly cargo install rustfmt-nightly
rustup component add rustfmt-preview --toolchain=nightly
```
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 ...`
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
To install from source, first checkout to the tag or branch you want to install, then issue