Merge pull request #3133 from otavio/rework-readme

[rust.git] / README.md

diff --git a/README.md b/README.md
index 3d976e01f04bb722aa2d573ef3616173c5c70302..f811123f72a128cdc250ecdf7a34fe844f1e7b22 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,28 +6,14 @@ If you'd like to help out (and you should, it's a fun project!), see
 [Contributing.md](Contributing.md) and our [Code of
 Conduct](CODE_OF_CONDUCT.md).
 
 [Contributing.md](Contributing.md) and our [Code of
 Conduct](CODE_OF_CONDUCT.md).
 

-We are changing the default style used by rustfmt. There is an ongoing [RFC
-process][fmt rfcs]. The last version using the old style was 0.8.6. From 0.9
-onwards, the RFC style is the default. If you want the old style back, you can
-use [legacy-rustfmt.toml](legacy-rustfmt.toml) as your rustfmt.toml.
-
-The current `master` branch uses libsyntax (part of the compiler). It is
-published as `rustfmt-nightly`. The `syntex` branch uses Syntex instead of
-libsyntax, it is published (for now) as `rustfmt`. Most development happens on
-the `master` branch, however, this only supports nightly toolchains. If you use
-stable or beta Rust toolchains, you must use the Syntex version (which is likely
-to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
-0.9 of the syntex branch.
-

 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
 using another repository. The status of that repository's build is reported by
 the "travis example" badge above.
 
 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
 using another repository. The status of that repository's build is reported by
 the "travis example" badge above.
 

-

 ## Quick start
 
 ## Quick start
 

-You can use `rustfmt` on Rust 1.24 and above.
+You can run `rustfmt` with Rust 1.24 and above.

 
 To install:
 
 
 To install:
 


@@ -88,6 +74,7 @@ rustup component add rustfmt-preview
 ## Installing from source
 
 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
 ## 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 .
 ```
 ```
 cargo install --path .
 ```


@@ -122,20 +109,21 @@ completed without error (whether or not changes were made).
 * [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
 * [Atom](atom.md)
 * Visual Studio Code using [vscode-rust](https://github.com/editor-rs/vscode-rust), [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt) or [rls_vscode](https://github.com/jonathandturner/rls_vscode) through RLS.
 * [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
 * [Atom](atom.md)
 * Visual Studio Code using [vscode-rust](https://github.com/editor-rs/vscode-rust), [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt) or [rls_vscode](https://github.com/jonathandturner/rls_vscode) through RLS.

+* [IntelliJ or CLion](intellij.md)
+

 
 ## Checking style on a CI server
 
 To keep your code base consistently formatted, it can be helpful to fail the CI build
 when a pull request contains unformatted code. Using `--check` instructs
 rustfmt to exit with an error code if the input is not formatted correctly.
 
 ## Checking style on a CI server
 
 To keep your code base consistently formatted, it can be helpful to fail the CI build
 when a pull request contains unformatted code. Using `--check` instructs
 rustfmt to exit with an error code if the input is not formatted correctly.

-It will also print any found differences.
+It will also print any found differences. (Older versions of Rustfmt don't
+support `--check`, use `--write-mode diff`).

 
 A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust
 
 A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust

-rust:
-- nightly

 before_script:
 - rustup component add rustfmt-preview
 script:
 before_script:
 - rustup component add rustfmt-preview
 script:


@@ -144,6 +132,9 @@ script:
 - cargo test
 ```
 
 - cargo test
 ```
 

+See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)
+for more info.
+

 ## How to build and test
 
 `cargo build` to build.
 ## How to build and test
 
 `cargo build` to build.


@@ -159,7 +150,7 @@ notes above on running rustfmt.
 Rustfmt is designed to be very configurable. You can create a TOML file called
 `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
 directory and it will apply the options in that file. See `rustfmt
 Rustfmt is designed to be very configurable. You can create a TOML file called
 `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
 directory and it will apply the options in that file. See `rustfmt

---config-help` for the options which are available, or if you prefer to see
+--help=config` for the options which are available, or if you prefer to see

 visual style previews, [Configurations.md](Configurations.md).
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
 visual style previews, [Configurations.md](Configurations.md).
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style


@@ -182,34 +173,28 @@ See [Configurations.md](Configurations.md) for details.
 * 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
 * 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
   install), make sure you have the most recent version of Rust installed.
 
 * 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
   install), make sure you have the most recent version of Rust installed.
 

-* If you get an error like `error while loading shared libraries` while starting
-  up rustfmt you should try the following:
-
-  On Linux:
+* You can change the way rustfmt emits the changes with the --emit flag:

 
 

-  ```
-  export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
-  ```
-
-  On MacOS:
+  Example:

 
   ```
 
   ```

-  export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
+  cargo fmt -- --emit files

   ```
 
   ```
 

-  On Windows (Git Bash/Mingw):
-
-  ```
-  export PATH=$(rustc --print sysroot)/lib/rustlib/x86_64-pc-windows-gnu/lib/:$PATH
-  ```
+  Options:

 
 

-  (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
+  | Flag |Description| Nightly Only |
+  |:---:|:---:|:---:|
+  | files | overwrites output to files | No |
+  | stdout | writes output to stdout | No |
+  | coverage | displays how much of the input file was processed | Yes |
+  | checkstyle | emits in a checkstyle format | Yes |

 
 ## License
 
 
 ## License