summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorjotaro-sama <36264038+jotaro-sama@users.noreply.github.com>2019-10-10 03:57:25 +0200
committerjotaro-sama <36264038+jotaro-sama@users.noreply.github.com>2019-10-10 03:57:25 +0200
commit35aa3c13311e12ff3375f2eef561562244433ee8 (patch)
treed81880bc236f8a843e90644ef72cfe5a487a42fb /plugins
parent710a3d5a1e2888a4dfb1769f8f1edd8a590eee22 (diff)
downloadzsh-35aa3c13311e12ff3375f2eef561562244433ee8.tar.gz
zsh-35aa3c13311e12ff3375f2eef561562244433ee8.tar.bz2
zsh-35aa3c13311e12ff3375f2eef561562244433ee8.zip
add readme for the rust plugin
Diffstat (limited to 'plugins')
-rw-r--r--plugins/rust/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/rust/README.md b/plugins/rust/README.md
new file mode 100644
index 000000000..7cc1ceb66
--- /dev/null
+++ b/plugins/rust/README.md
@@ -0,0 +1,15 @@
+# rust
+
+This plugin adds completion for [`rustc`](https://doc.rust-lang.org/rustc/index.html), the compiler for the Rust programming language.
+
+To use it, add `rust` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... rust)
+```
+
+## Aliases
+
+| Command | Description |
+|------------------|---------------------------------------------------------------------------------|
+| `rustc` | Compiler for the Rust language |