Skip to content

Commit 70c0bb4

Browse files
committed
Merge pull request #768 from pandeiro/master
Auto-completion instructions
2 parents b2972cf + 48b5233 commit 70c0bb4

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
@@ -395,6 +395,31 @@ If you are using `ido`, be sure to use both `ido-everywhere`
395395
and [`ido-ubiquitous`](https://github.com/DarwinAwardWinner/ido-ubiquitous).
396396
You might also want to install [`ido-flex`](https://github.com/lewang/flx).
397397

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

400425
* Enabling `CamelCase` support for editing commands(like
@@ -437,17 +462,10 @@ enable `paredit` in the REPL buffer as well:
437462
(add-hook 'cider-repl-mode-hook 'rainbow-delimiters-mode)
438463
```
439464

440-
* [company-mode](http://company-mode.github.io/) provides in-buffer completion
441-
framework. When `company-mode` is enabled, it will retrieve completion
442-
information from `cider-complete-at-point`, requiring no additional setup (and
443-
no `company-mode` plugins). `CIDER` users are advised to use `company-mode`
444-
instead of `auto-complete-mode` for optimal results.
445-
446-
* [ac-cider](https://github.com/clojure-emacs/ac-cider) provides
447-
completion source for the popular Emacs interactive auto-completion
448-
framework [auto-complete](http://cx4a.org/software/auto-complete/).
449-
Where CIDER provides it, pop-up documentation for completed symbols
450-
will be displayed.
465+
* [auto-complete](http://cx4a.org/software/auto-complete/) is a popular Emacs
466+
interactive auto-completion framework. [ac-cider](https://github.com/clojure-emacs/ac-cider)
467+
provides a completion source for auto-complete-mode, including, where CIDER provides it,
468+
pop-up documentation for completed symbols.
451469

452470
## Basic Usage
453471

0 commit comments

Comments
 (0)