1
0
Fork 0

better formatting for the README

pull/730/head
mkcode 10 years ago
parent 14cfdc7760
commit 442cabc2a9

@ -1,28 +1,22 @@
Project Jump # Project Jump
============
Provides `pj` function and aliases that quickly jumps to pre-specified Provides `pj` function and aliases that quickly jumps to pre-specified directories.
directories.
Usage ## Usage
-----
- Set `$PROJECT_PATHS` in your ~/.zshrc - Set `$PROJECT_PATHS` in your ~/.zshrc
```shell ```shell
# Set space separated directories for tab-completion jumping with pj # Set space separated directories for tab-completion jumping with pj
PROJECT_PATHS=(~/src ~/work) PROJECT_PATHS=(~/src ~/work)
``` ```
- In ZSH you now can open a project directory with the command: `pj my-project` - In ZSH you now can open a project directory with the command: `pj my-project`
the plugin will locate the `my-project` directory in one of the $PROJECT_PATHS the plugin will locate the `my-project` directory in one of the $PROJECT_PATHS
Also tab completion is supported. with tab completion.
- `pjo my-project` will open the directory in $EDITOR - `pjo my-project` will open the directory in $EDITOR
Comparison with fasd ## Comparison with fasd
-------------------- - The fasd module which allows quick jumping to all visited directories in most frequently visited order and many more features.
- The fasd module which allows quick jumping to all visited directories
in most frequently visited order and many more features.
- Prefer pj if you just want simple tab completion of common directories. - Prefer pj if you just want simple tab completion of common directories.
- No issue with using both pj and fasd at the same time. - No issue with using both pj and fasd at the same time.

Loading…
Cancel
Save