## Quick start
-You can use `rustfmt` on Rust 1.24 and above.
+You can run `rustfmt` with Rust 1.24 and above.
To install:
cargo +nightly fmt
```
+To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing:
+
+```toml
+edition = "Edition2018"
+```
+
## Limitations
Rustfmt tries to work on as much Rust code as possible, sometimes, the code
## Installing from source
To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
+
```
cargo install --path .
```
* When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
target file directory or its parents to override the default settings of
rustfmt. You can generate a file containing the default configuration with
- `rustfmt --dump-default-config rustfmt.toml` and customize as needed.
+ `rustfmt --print-config default rustfmt.toml` and customize as needed.
* After successful compilation, a `rustfmt` executable can be found in the
target directory.
* If you're having issues compiling Rustfmt (or compile errors when trying to