]> git.lizzy.rs Git - rust.git/blobdiff - README.md
update dependencies and fix compile errors
[rust.git] / README.md
index d7566d84765823d2a99dfec65d53a9ceb5e31b8c..571ceb99f6c6c3b7820a83253958a59909131685 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,30 +1,32 @@
-# rustfmt [![Build Status](https://travis-ci.org/nrc/rustfmt.svg)](https://travis-ci.org/nrc/rustfmt)
+# rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt)
 
 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](Contributing.md).
 
 
 ## Installation
 
-> **Note:** this method currently requires you to be running a nightly install
-> of Rust as `cargo install` has not yet made its way onto the stable channel.
+> **Note:** this method currently requires you to be running cargo 0.6.0 or
+> newer.
 
 ```
-cargo install --git https://github.com/nrc/rustfmt
+cargo install --git https://github.com/rust-lang-nursery/rustfmt
 ```
 
 or if you're using [`multirust`](https://github.com/brson/multirust)
 
 ```
-multirust run nightly cargo install --git https://github.com/nrc/rustfmt
+multirust run nightly cargo install --git https://github.com/rust-lang-nursery/rustfmt
 ```
 
 
-## Running Rustfmt from Vim
+## Running Rustfmt from your editor
 
-See [instructions](http://johannh.me/blog/rustfmt-vim.html).
+* [Vim](http://johannh.me/blog/rustfmt-vim.html)
+* [Emacs](https://github.com/fbergroth/emacs-rustfmt)
+* [Atom](atom.md)
 
 
 ## How to build and test
@@ -54,7 +56,7 @@ screen, for example.
 
 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 `cargo run --help-config` for the options which are available,
+in that file. See `cargo run -- --config-help` for the options which are available,
 or if you prefer to see source code, [src/config.rs].
 
 By default, Rustfmt uses a style which (mostly) confirms to the
@@ -72,6 +74,7 @@ options covering different styles. File an issue, or even better, submit a PR.
 ## Gotchas
 
 * For things you do not want rustfmt to mangle, use one of
+
     ```rust
     #[rustfmt_skip]
     #[cfg_attr(rustfmt, rustfmt_skip)]