Remove rewrite_call_with_binary_search()

[rust.git] / README.md

diff --git a/README.md b/README.md
index f0db80039bdd8fd0cc74113feb45048df75d83e2..1fc7275dd96d14db144c01f50db93c7fa8db38b7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@ to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
 
 ## Quick start
 
-You must be using a nightly compiler toolchain.
+You must be using the latest nightly compiler toolchain.
 
 To install:
 
@@ -44,6 +44,7 @@ cargo install rustfmt-nightly
 or if you're using [Rustup](https://www.rustup.rs/)
 
 ```
+rustup update
 rustup run nightly cargo install rustfmt-nightly
 ```
 
@@ -89,11 +90,12 @@ read data from stdin. Alternatively, you can use `cargo fmt` to format all
 binary and library targets of your crate.
 
 You'll probably want to specify the write mode. Currently, there are modes for
-diff, replace, overwrite, display, coverage, and checkstyle.
+`diff`, `replace`, `overwrite`, `display`, `coverage`, `checkstyle`, and `plain`.
 
-* `replace` Is the default and overwrites the original files after creating backups of the files.
-* `overwrite` Overwrites the original files _without_ creating backups.
+* `overwrite` Is the default and overwrites the original files _without_ creating backups.
+* `replace` Overwrites the original files after creating backups of the files.
 * `display` Will print the formatted files to stdout.
+* `plain` Also writes to stdout, but with no metadata.
 * `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,
@@ -102,7 +104,7 @@ diff, replace, overwrite, display, coverage, and checkstyle.
 The write mode can be set by passing the `--write-mode` flag on
 the command line. For example `rustfmt --write-mode=display src/filename.rs`
 
-`cargo fmt` uses `--write-mode=replace` by default.
+`cargo fmt` uses `--write-mode=overwrite` by default.
 
 If you want to restrict reformatting to specific sets of lines, you can
 use the `--file-lines` option. Its argument is a JSON array of objects
@@ -212,6 +214,28 @@ options covering different styles. File an issue, or even better, submit a PR.
 * 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).
 
 ## License