Skip to content

Commit 48b5233

Browse files
committed
Clarify auto-complete instructions
1 parent 27e4e07 commit 48b5233

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

README.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,31 @@ If you are using `ido`, be sure to use both `ido-everywhere`
388388
and [`ido-ubiquitous`](https://github.com/DarwinAwardWinner/ido-ubiquitous).
389389
You might also want to install [`ido-flex`](https://github.com/lewang/flx).
390390

391+
### Auto-completion
392+
393+
`CIDER` users are advised to use [`company-mode`](http://company-mode.github.io/) to enable auto-completion
394+
inside of source code and REPL buffers. This can be done globally, like so --
395+
396+
```el
397+
(global-company-mode)
398+
```
399+
400+
-- or through mode-specific hooks:
401+
402+
```el
403+
(add-hook 'cider-repl-mode-hook 'company-mode)
404+
(add-hook 'cider-mode-hook 'company-mode)
405+
```
406+
407+
When `company-mode` is thus enabled, it will receive completion information
408+
from `cider-complete-at-point`, and requires no additional setup or plugins.
409+
410+
#### Migrating from `auto-complete-mode`
411+
412+
* Disable `ac-cider-setup` or `ac-nrepl-setup` from running on `CIDER` hooks
413+
414+
* Remove `cider-mode` and `cider-repl-mode` from the `ac-modes` list
415+
391416
### Integration with other modes
392417

393418
* Enabling `CamelCase` support for editing commands(like
@@ -430,17 +455,10 @@ enable `paredit` in the REPL buffer as well:
430455
(add-hook 'cider-repl-mode-hook 'rainbow-delimiters-mode)
431456
```
432457

433-
* [company-mode](http://company-mode.github.io/) provides in-buffer completion
434-
framework. When `company-mode` is enabled, it will retrieve completion
435-
information from `cider-complete-at-point`, requiring no additional setup (and
436-
no `company-mode` plugins). `CIDER` users are advised to use `company-mode`
437-
instead of `auto-complete-mode` for optimal results.
438-
439-
* [ac-cider](https://github.com/clojure-emacs/ac-cider) provides
440-
completion source for the popular Emacs interactive auto-completion
441-
framework [auto-complete](http://cx4a.org/software/auto-complete/).
442-
Where CIDER provides it, pop-up documentation for completed symbols
443-
will be displayed.
458+
* [auto-complete](http://cx4a.org/software/auto-complete/) is a popular Emacs
459+
interactive auto-completion framework. [ac-cider](https://github.com/clojure-emacs/ac-cider)
460+
provides a completion source for auto-complete-mode, including, where CIDER provides it,
461+
pop-up documentation for completed symbols.
444462

445463
## Basic Usage
446464

0 commit comments

Comments
 (0)