From 11552bf9add056cbc81eba2236915d3f0097dcfc Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Sun, 6 May 2018 13:30:52 +0300 Subject: [PATCH] Simplify the Projectile README section --- README.md | 35 +++++++++-------------------------- 1 file changed, 9 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index f7d3c5b..7c10068 100644 --- a/README.md +++ b/README.md @@ -376,38 +376,21 @@ instead. That's an epic productivity boost and it's not as crazy as it sounds! #### Projectile -Here's a list of functionality provided by [Projectile](https://github.com/bbatsov/projectile): +[Projectile](https://github.com/bbatsov/projectile) is one of the essential packages bundled with Prelude. +It provides an easy way to navigate and switch projects. Take a look at its extensive documentation +to get a feel for everything you can do with Projectile. -Keybinding | Description --------------------|------------------------------------------------------------ -C-c p f | Display a list of all files in the project. With a prefix argument it will clear the cache first. -C-c p d | Display a list of all directories in the project. With a prefix argument it will clear the cache first. -C-c p T | Display a list of all test files(specs, features, etc) in the project. -C-c p s g | Run grep on the files in the project. -C-c p s s | Runs `ag` on the project. Requires the presence of `ag.el`. -M-- C-c p s g | Run grep on `projectile-grep-default-files` in the project. -C-c p b | Display a list of all project buffers currently open. -C-c p o | Runs `multi-occur` on all project buffers currently open. -C-c p r | Runs interactive query-replace on all files in the projects. -C-c p i | Invalidates the project cache (if existing). -C-c p R | Regenerates the projects `TAGS` file. -C-c p k | Kills all project buffers. -C-c p D | Opens the root of the project in `dired`. -C-c p e | Shows a list of recently visited project files. -C-c p a | Switch between files with the same name but different extensions. -C-c p c | Runs a standard compilation command for your type of project. -C-c p P | Runs a standard test command for your type of project. -C-c p z | Adds the currently visited to the cache. -C-c p p | Display a list of known projects you can switch to. - -Prelude adds an extra keymap prefix `S-p` (`S` stands for -`Super`), so you can use `S-p` instead of `C-c p`. By default on Windows keyboard +Prelude adds an extra keymap prefix `s-p` (`s` stands for +`Super`) in addition to the standard one `C-c p`. By default on Windows keyboard `Super` is mapped to the `Windows` key and on macOS keyboards `Super` is mapped to the `Command` key. If you ever forget any of Projectile's keybindings just do a: -C-c p C-h +C-c p C-h or s-p C-h + +Alternatively you can just press s-p and wait for a moment +for `which-key` to kick in and show you the available keybindings. #### Helm