summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristopher Warrington <chwarr@microsoft.com>2020-05-09 02:53:22 -0700
committerGitHub <noreply@github.com>2020-05-09 11:53:22 +0200
commit7fdb9c2f39de270f6d161a7163d1673fbc79b26a (patch)
tree5d510d13b5c10a272c8f03108080b803aedb103d /README.md
parent08d714136153240864ac61c37aae0d2690a34a65 (diff)
downloadrust-mode-7fdb9c2f39de270f6d161a7163d1673fbc79b26a.tar.gz
Use <kbd> to indicate keyboard input in README (#375)
Fixes the flow of the sentence "Command like TAB should indent correctly." Previously, on GitHub, this read as "Commands like should indent correctly." On GitHub, <kbd> elements also look like keyboard keys.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1b705b8..1cc705f 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,7 @@ Clone this repository locally, and add this to your init.el:
# Feature guide
## Indentation
-Commands like <TAB> should indent correctly.
+Commands like <kbd>TAB</kbd> should indent correctly.
The Rust style guide recommends spaces rather than tabs for
indentation; to follow the recommendation add this to your init.el,
@@ -85,7 +85,7 @@ which forces indentation to always use spaces.
The `rust-format-buffer` function will format your code with
[rustfmt](https://github.com/rust-lang/rustfmt) if installed. By
-default, this is bound to `C-c C-f`.
+default, this is bound to <kbd>C-c C-f</kbd>.
The variable `rust-format-on-save` enables automatic formatting on
save. For example, add the following in your init.el to enable format
@@ -117,7 +117,7 @@ you can use the following in your init.el:
in `dbg!`. This can be useful for easily adding debug lines to your
program.
-This is bound to `C-c C-d` by default.
+This is bound to <kbd>C-c C-d</kbd> by default.
# Other recommended packages