maciej/counsel-projectile
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix typos in readme

Browse source
This commit is contained in:
Eric Danan 2016-09-15 16:35:41 +02:00
parent b8e672be14
commit fdce7664bb
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -16,15 +16,16 @@ You can use counsel-projectile (and in particular call the command `counsel-proj
# Usage
The main command `counsel-projectile`, and can be called with <kbd>C-c p SPC</kbd> (assuming the variable `projectile-keymap-prefix` has been left at its default value, <kbd>C-c p</kbd>). This command behaves differently depending on whether you call it from inside a project or not:
- If you are not inside a project, call the function `counsel-projectile-switch-project`. This uses ivy to display a list of all known projects and let you select a project to switch to. You can choose from a number of actions to be applied upon switching (using <kbd>M-o</kbd> or <kbd>C-M-o</kbd>, as usual with ivy).
- If you are inside a project, call the function `counsel-projectile-find-file-or-buffer`. This uses ivy to display a list of all project buffers and files. The project buffers are fontified, and the project files that are not currently open are shown as "virtual buffers" with a different font (as in the function `ivy-switch-buffer`). You can choose to visit the selected file or display the selected buffer in the current or another window. If you would rather switch to a different project, you can so with <kbd>M-SPC</kbd>.
The main command is `counsel-projectile`, and can be called with <kbd>C-c p SPC</kbd> (assuming the variable `projectile-keymap-prefix` has been left at its default value, <kbd>C-c p</kbd>). This command behaves differently depending on whether you call it from inside a project or not:
- If you are not inside a project, it calls the function `counsel-projectile-switch-project`. This uses ivy to display a list of all known projects and let you select a project to switch to. You can choose from a number of actions to be applied upon switching (using <kbd>M-o</kbd> or <kbd>C-M-o</kbd>, as usual with ivy).
- If you are inside a project, it calls the function `counsel-projectile-find-file-or-buffer` instead. This uses ivy to display a list of all project buffers and files. The project buffers are fontified, and the project files that are not currently open are shown as "virtual buffers" with a different font (as in the function `ivy-switch-buffer`). You can choose to visit the selected file / display the selected buffer in the current or another window. If you would rather switch to a different project, you can so with <kbd>M-SPC</kbd>.
Counsel-projectile also provides replacements for several standard projectile commands, which take advantage of ivy to let you choose from several actions. To install these replacements, call the command `counsel-projectile-on`. Here are the currently defined replacements, with their default key-bindings:
- <kbd>C-c p f</kbd> `counsel-projectile-find-file`: find a project file,
- <kbd>C-c p d</kbd> `counsel-projectile-find-dir`: find a project directory,
- <kbd>C-c p b</kbd> `counsel-projectile-switch-to-buffer`: switch to a project buffer,
- <kbd>C-c p p</kbd> `counsel-projectile-switch-project`: switch to another project (see above).
If your default action for switching to a project (stored in the variable `projectile-switch-project-action`) is `projectile-find-file` (the default), then `counsel-projectile-on` also replaces it with `counsel-projectile-find-file-or-buffer` (see above).
You can call the command `counsel-projectile-off` to undo all changes made by `counsel-projectile-on`.