aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.dev>2022-10-25 12:07:15 +0300
committerBozhidar Batsov <bozhidar@batsov.dev>2022-10-25 12:07:15 +0300
commit5ad69d5421d65f317be26d702c6444848951ca2a (patch)
tree0eefaacb69f8a990a071538933739747b2342c54 /README.md
parente3bae8c91bb69c501dcc2e74f9ea14e89cf0a09c (diff)
[Fix #1795] Mention minibuffer completion frameworks in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index b059104..f706650 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,10 @@ Enable `projectile-mode`, open a file in one of your projects and type a command
See the [online documentation](https://docs.projectile.mx) for more details.
+To get the most of Projectile you also need to enable (and potentially install) some minibuffer completion framework (e.g. `ido`, `ivy` or `selectrum`). See [this section](https://docs.projectile.mx/projectile/configuration.html#completion-options) of the documentation for more details.
+
+**Note:** Historically `projectile-completion-system` defaulted to `ido`, but this was changed in version 2.3. You may need to enable `ido-mode` in your Emacs configuration if updating from an older version of Projectile.
+
## Caveats
* Some operations like search (grep) depend (presently) on external