summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTrevor Spiteri <tspiteri@ieee.org>2019-10-11 12:31:01 +0200
committerNathan Moreau <nathan.moreau@m4x.org>2019-10-11 18:33:41 +0200
commitbb9bbd24df2294f40f77d031fe2f5defeb103931 (patch)
treefaee47cf0a5af097d89289826c049e73acd95123 /README.md
parent06b3b60558f40e6eb1ac9b4720da0ae1fff08a29 (diff)
downloadrust-mode-bb9bbd24df2294f40f77d031fe2f5defeb103931.tar.gz
readme: recommend setting indent-tabs-mode to nil
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 34a3fc2..e4af066 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@
- [Installation via MELPA](#installation-via-melpa)
- [Manual Installation](#manual-installation)
+- [Indentation](#indentation)
- [rustfmt](#rustfmt)
- [Tests](#tests)
- [Other useful packages](#other-useful-packages)
@@ -44,6 +45,16 @@ Add this to your init.el:
(autoload 'rust-mode "rust-mode" nil t)
```
+# Indentation
+
+The Rust style guide recommends spaces for indentation; to follow the
+recommendation add this to your init.el:
+
+```elisp
+(add-hook 'rust-mode-hook
+ (lambda () (setq indent-tabs-mode nil)))
+```
+
# rustfmt
The `rust-format-buffer` function will format your code with