Use correct budget

[rust.git] / README.md

diff --git a/README.md b/README.md
index 8e5b40b8af8e846c94ebf629acfab0cb53e63e5c..fa4e9d6c4e2392859cc4020be2faafbb4ead00f0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,11 @@ A tool for formatting Rust code according to style guidelines.
 If you'd like to help out (and you should, it's a fun project!), see
 [Contributing.md](Contributing.md).
 
+If you want latest and greatest, you should use the [libsyntax](https://github.com/rust-lang-nursery/rustfmt/tree/libsyntax)
+branch. It supports some newer Rust syntax which is missing from master and
+fixes some bugs. However, it links against libsyntax from the Rust compiler, so
+you must be using a nightly version of Rust to use it.
+
 ## Quick start
 
 To install:
@@ -28,10 +33,10 @@ cargo fmt
 cargo install rustfmt
 ```
 
-or if you're using [`multirust`](https://github.com/brson/multirust)
+or if you're using [`rustup.rs`](https://www.rustup.rs/)
 
 ```
-multirust run nightly cargo install rustfmt
+rustup run nightly cargo install rustfmt
 ```
 
 Usually cargo-fmt, which enables usage of Cargo subcommand `cargo fmt`, is
@@ -46,7 +51,7 @@ To install from source, first checkout to the tag or branch you want to install,
 ```
 cargo install --path  .
 ```
-This will install `rustfmt` in your `~/.cargo/bin`. Make sure to add `~/.cargo/bin` directory to 
+This will install `rustfmt` in your `~/.cargo/bin`. Make sure to add `~/.cargo/bin` directory to
 your PATH variable.
 
 ## Running
@@ -65,6 +70,7 @@ diff, replace, overwrite, display, coverage, and checkstyle.
 * `overwrite` Overwrites the original files _without_ creating backups.
 * `display` Will print the formatted files to stdout.
 * `diff` Will print a diff between the original files and formatted files to stdout.
+         Will also exit with an error code if there are any differences.
 * `checkstyle` Will output the lines that need to be corrected as a checkstyle XML file,
   that can be used by tools like Jenkins.
 
@@ -105,11 +111,34 @@ You can run `rustfmt --help` for more information.
 
 ## Running Rustfmt from your editor
 
-* [Vim](https://github.com/rust-lang/rust.vim#enabling-autoformat)
-* [Emacs](https://github.com/fbergroth/emacs-rustfmt)
+* [Vim](https://github.com/rust-lang/rust.vim#formatting-with-rustfmt)
+* [Emacs](https://github.com/rust-lang/rust-mode)
 * [Sublime Text 3](https://packagecontrol.io/packages/BeautifyRust)
 * [Atom](atom.md)
-* Visual Studio Code using [RustyCode](https://github.com/saviorisdead/RustyCode) or [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt)
+* 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.
+
+## 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 `--write-mode=diff` instructs
+rustfmt to exit with an error code if the input is not formatted correctly.
+It will also print any found differences.
+
+A minimal Travis setup could look like this:
+
+```yaml
+language: rust
+cache: cargo
+before_script:
+- export PATH="$PATH:$HOME/.cargo/bin"
+- which rustfmt || cargo install rustfmt
+script:
+- cargo fmt -- --write-mode=diff
+- cargo build
+- cargo test
+```
+
+Note that using `cache: cargo` is optional but highly recommended to speed up the installation.
 
 ## How to build and test
 
@@ -124,12 +153,13 @@ notes above on running rustfmt.
 ## Configuring Rustfmt
 
 Rustfmt is designed to be very configurable. You can create a TOML file called
-rustfmt.toml, place it in the project 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 source code, [src/config.rs](src/config.rs).
+`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
+visual style previews, [Configurations.md](Configurations.md).
 
 By default, Rustfmt uses a style which (mostly) conforms to the
-[Rust style guidelines](https://github.com/rust-lang/rust/tree/master/src/doc/style).
+[Rust style guidelines](https://doc.rust-lang.org/1.12.0/style/README.html).
 There are many details which the style guidelines do not cover, and in these
 cases we try to adhere to a style similar to that used in the
 [Rust repo](https://github.com/rust-lang/rust). Once Rustfmt is more complete, and
@@ -148,8 +178,9 @@ options covering different styles. File an issue, or even better, submit a PR.
     #[rustfmt_skip]  // requires nightly and #![feature(custom_attribute)] in crate root
     #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
     ```
-* When you run rustfmt, place a file named rustfmt.toml in target file
-  directory or its parents to override the default settings of rustfmt.
+* 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.
 * 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