change new line point in the case of no args

[rust.git] / README.md

diff --git a/README.md b/README.md
index 04f9f2f928c8de6ed1fc9743b41e90303bdede6e..02e6892a2e07f6af752d61c5b9f222d0d30584b1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rustfmt?svg=true)](https://ci.appveyor.com/project/nrc/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly) [![Travis Configuration Status](https://img.shields.io/travis/davidalber/rustfmt-travis.svg?label=travis%20example)](https://travis-ci.org/davidalber/rustfmt-travis)
+# rustfmt [![Build Status](https://travis-ci.org/rust-lang/rustfmt.svg)](https://travis-ci.org/rust-lang/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang/rustfmt?svg=true)](https://ci.appveyor.com/project/nrc/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly) [![Travis Configuration Status](https://img.shields.io/travis/davidalber/rustfmt-travis.svg?label=travis%20example)](https://travis-ci.org/davidalber/rustfmt-travis)
 
 A tool for formatting Rust code according to style guidelines.
 
@@ -18,7 +18,7 @@ You can run `rustfmt` with Rust 1.24 and above.
 To install:
 
 ```
-rustup component add rustfmt-preview
+rustup component add rustfmt
 ```
 
 to run on a cargo project in the current working directory:
@@ -29,19 +29,13 @@ cargo fmt
 
 For the latest and greatest `rustfmt` (nightly required):
 ```
-rustup component add rustfmt-preview --toolchain nightly
+rustup component add rustfmt --toolchain nightly
 ```
 To run:
 ```
 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
@@ -74,7 +68,7 @@ because in the future Rustfmt might work on code where it currently does not):
 ## Installation
 
 ```
-rustup component add rustfmt-preview
+rustup component add rustfmt
 ```
 
 ## Installing from source
@@ -98,7 +92,7 @@ just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
 read data from stdin. Alternatively, you can use `cargo fmt` to format all
 binary and library targets of your crate.
 
-You can run `rustfmt --help` for information about argument.
+You can run `rustfmt --help` for information about available arguments.
 
 When running with `--check`, Rustfmt will exit with `0` if Rustfmt would not
 make any formatting changes to the input, and `1` if Rustfmt would make changes.
@@ -115,6 +109,7 @@ 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.
+* [IntelliJ or CLion](intellij.md)
 
 
 ## Checking style on a CI server
@@ -129,10 +124,8 @@ 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
+- rustup component add rustfmt
 script:
 - cargo fmt --all -- --check
 - cargo build
@@ -171,12 +164,7 @@ See [Configurations.md](Configurations.md) for details.
 
 ## Tips
 
-* For things you do not want rustfmt to mangle, use one of
-
-    ```rust
-    #[rustfmt::skip]  // requires nightly Rust and #![feature(tool_attributes)] in crate root
-    #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
-    ```
+* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`
 * 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
@@ -186,35 +174,12 @@ See [Configurations.md](Configurations.md) for details.
 * 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:
-
-  ```
-  export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
-  ```
-
-  On MacOS:
-
-  ```
-  export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
-  ```
-
-  On Windows (Git Bash/Mingw):
-
-  ```
-  export PATH=$(rustc --print sysroot)/lib/rustlib/x86_64-pc-windows-gnu/lib/:$PATH
-  ```
-
-  (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
-
 * You can change the way rustfmt emits the changes with the --emit flag:
 
   Example:
 
   ```
-  cargo fmt --emit files
+  cargo fmt -- --emit files
   ```
 
   Options:
@@ -222,7 +187,7 @@ See [Configurations.md](Configurations.md) for details.
   | Flag |Description| Nightly Only |
   |:---:|:---:|:---:|
   | files | overwrites output to files | No |
-  | stdout | writes output to stdout | 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 |