diff options
| author | Niko Matsakis <niko@alum.mit.edu> | 2017-04-11 10:43:51 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-11 10:43:51 -0400 |
| commit | a436945f788e153474c0ec149a565993804fc6a5 (patch) | |
| tree | 65210c84fda06746f428175ac063a83b0336a59f /README.md | |
| parent | 19e6f604a0c9d838a1426604d70ce3af0960621d (diff) | |
| parent | 7f7b2ac38e419a1398d68b75bc25f5fa092e0152 (diff) | |
| download | rust-mode-a436945f788e153474c0ec149a565993804fc6a5.tar.gz | |
Merge pull request #172 from nokaa/master
Add info to enable rustfmt
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -4,6 +4,8 @@ `rust-mode` makes editing [Rust](http://rust-lang.org) code with Emacs enjoyable. `rust-mode` requires Emacs 24 or later. +## Installation + ### Manual Installation To install manually, check out this repository and add this to your @@ -74,6 +76,18 @@ The file `rust-mode-tests.el` contains tests that can be run via You can use `run_rust_emacs_tests.sh` to run them in batch mode, if you set the environment variable EMACS to a program that runs emacs. +## Features + +### Formatting with [rustfmt][rfmt] + +The `rust-format-buffer` function will format your code with +[rustfmt][rfmt] if installed. By default, this is bound to `C-c C-f`. + +Placing `(setq rust-format-on-save t)` in your `~/.emacs` will enable automatic +running of `rust-format-buffer` when you save a buffer. + +[rfmt]: https://crates.io/crates/rustfmt/ + ## License `rust-mode` is distributed under the terms of both the MIT license and the |