Use correct budget

[rust.git] / README.md

diff --git a/README.md b/README.md
index fbb5fbbc17ad70cfbe72fcc014807631c5af62b2..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:
@@ -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
@@ -110,7 +115,7 @@ You can run `rustfmt --help` for more information.
 * [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
 
@@ -124,13 +129,13 @@ A minimal Travis setup could look like this:
 ```yaml
 language: rust
 cache: cargo
-before_script: (cargo install rustfmt || true)
+before_script:
+- export PATH="$PATH:$HOME/.cargo/bin"
+- which rustfmt || cargo install rustfmt
 script:
-- |
-  export PATH=$PATH:~/.cargo/bin &&
-  cargo fmt -- --write-mode=diff &&
-  cargo build &&
-  cargo test
+- cargo fmt -- --write-mode=diff
+- cargo build
+- cargo test
 ```
 
 Note that using `cache: cargo` is optional but highly recommended to speed up the installation.
@@ -151,10 +156,10 @@ 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
-source code, [src/config.rs](src/config.rs).
+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