X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=420859e90513df2a31060ae898c16d852bb56a11;hb=1644b174a73658b211ed700b3dad4223c9c937b9;hp=86dc4dd8d3003afda22098e410dcbb1557d8ddfd;hpb=c2fda14e0ae74c40d4815b423bfcd5466b1490a5;p=rust.git

diff --git a/README.md b/README.md
index 86dc4dd8d30..420859e9051 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
-# 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)
+# 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)
 
 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](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
@@ -18,49 +19,64 @@ 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.
+
 
 ## Quick start
 
-Currently, you can use `rustfmt` on nightly and beta. Rust 1.24 stable will work,
-but we're not quite there yet!
+You can use `rustfmt` on Rust 1.24 and above.
 
 To install:
 
 ```
-rustup component add rustfmt-preview --toolchain=nightly
+rustup component add rustfmt-preview
 ```
 
-If `nightly` is your default toolchain, you can leave the `--toolchain` off.
-
 to run on a cargo project in the current working directory:
 
 ```
-cargo +nightly fmt
+cargo fmt
 ```
 
-If `nightly` is your default toolchain, you can leave off the `+nightly`.
 
-## Installation
+## Limitations
 
-```
-rustup component add rustfmt-preview --toolchain=nightly
-```
+Rustfmt tries to work on as much Rust code as possible, sometimes, the code
+doesn't even need to compile! As we approach a 1.0 release we are also looking
+to limit areas of instability; in particular, post-1.0, the formatting of most
+code should not change as Rustfmt improves. However, there are some things that
+Rustfmt can't do or can't do well (and thus where formatting might change
+significantly, even post-1.0). We would like to reduce the list of limitations
+over time.
 
-If you don't have a nightly toolchain, you can add it using rustup:
+The following list enumerates areas where Rustfmt does not work or where the
+stability guarantees do not apply (we don't make a distinction between the two
+because in the future Rustfmt might work on code where it currently does not):
 
-```
-rustup install nightly
-```
+* a program where any part of the program does not parse (parsing is an early
+  stage of compilation and in Rust includes macro expansion).
+* Macro declarations and uses (current status: some macro declarations and uses
+  are formatted).
+* Comments, including any AST node with a comment 'inside' (Rustfmt does not
+  currently attempt to format comments, it does format code with comments inside, but that formatting may change in the future).
+* Rust code in code blocks in comments.
+* Any fragment of a program (i.e., stability guarantees only apply to whole
+  programs, even where fragments of a program can be formatted today).
+* Code containing non-ascii unicode characters (we believe Rustfmt mostly works
+  here, but do not have the test coverage or experience to be 100% sure).
+* Bugs in Rustfmt (like any software, Rustfmt has bugs, we do not consider bug
+  fixes to break our stability guarantees).
 
-You can make the nightly toolchain the default by running:
+
+## Installation
 
 ```
-rustup default nightly
+rustup component add rustfmt-preview
 ```
 
-If you choose not to do that you'll have to run rustfmt using `rustup run ...`
-or by adding `+nightly` to the cargo invocation.
-
 ## Installing from source
 
 To install from source, first checkout to the tag or branch you want to install, then issue
@@ -143,16 +159,14 @@ when a pull request contains unformatted code. Using `--write-mode=diff` instruc
 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:
+A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust
 before_script:
-- rustup toolchain install nightly
-- rustup component add --toolchain nightly rustfmt-preview
-- which rustfmt || cargo install --force rustfmt-nightly
+- rustup component add rustfmt-preview
 script:
-- cargo +nightly fmt --all -- --write-mode=diff
+- cargo fmt --all -- --write-mode=diff
 - cargo build
 - cargo test
 ```