summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLars Andersen <expez@expez.com>2015-07-03 12:35:38 +0200
committerLars Andersen <expez@expez.com>2015-07-04 11:33:32 +0200
commitdbd910b9cf426788506592b33b6e22f3656b921f (patch)
tree48c3e589fb6aba8b199830a832f5bfa4f40e3ee9 /README.md
parent0a8d54edea80f7f9c85e528472c63e0c2ea30dcd (diff)
Mention manual completion with company in readme
This adds a new section to the readme for users who prefers to trigger completions manually.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4ae8b7e2..ad7bc271 100644
--- a/README.md
+++ b/README.md
@@ -507,7 +507,7 @@ You might also want to install [`ido-flex`](https://github.com/lewang/flx).
### Auto-completion
`CIDER` users are advised to use [`company-mode`](http://company-mode.github.io/) to enable auto-completion
-inside of source code and REPL buffers. To install company-mode do:
+inside of source code and REPL buffers. To install `company-mode` do:
`M-x package-install <RET> company <RET>`
@@ -527,6 +527,21 @@ After installation, company can be turned on globally, like so --
When `company-mode` is thus enabled, it will receive completion information
from `cider-complete-at-point`, and requires no additional setup or plugins.
+If you'd prefer to trigger completions manually you can add this to you config:
+
+```el
+(setq company-idle-delay nil) ; never start completions automatically
+(global-set-key (kbd "M-TAB") #'company-complete) ; use meta+tab, aka C-M-i, as manual trigger
+```
+
+To make `tab` complete, without losing the ability to manually indent, you can add this to your config:
+
+```el
+(global-set-key (kbd "TAB") #'company-indent-or-complete-common)
+```
+
+`company-indent-or-complete-common` requires a version of `company-mode` newer than `0.8.12`.
+
#### Migrating from `auto-complete-mode`
* Disable `ac-cider-setup` or `ac-nrepl-setup` from running on `CIDER` hooks