doc: code review changes.

This commit is contained in:
Alexandre Beaulieu 2019-10-01 17:41:34 -04:00
parent 507bd277a9
commit 286cb9f97f
No known key found for this signature in database
GPG key ID: 8B02EA7AE3FC7081
3 changed files with 13 additions and 27 deletions

View file

@ -52,42 +52,38 @@ brew install denisidoro/tools/navi
Alternatively, you can `git clone` this repository and run `make`:
```sh
git clone --depth 1 http://github.com/denisidoro/navi /opt/navi
git clone --depth 1 https://github.com/denisidoro/navi /opt/navi
cd /opt/navi
sudo make install
# install fzf: https://github.com/junegunn/fzf
```
### Using oh-my-zsh
Make sure that your oh-my-zsh `ZSH_CUSTOM` directory is configured,
then clone navi into the plugins directory.
Make sure that your oh-my-zsh `$ZSH_CUSTOM` directory is configured, then clone navi into the plugins directory.
```sh
export ZSH_CUSTOM='/path/to/.zsh'
DST="$ZSH_CUSTOM/plugins"
mkdir -p "$DST" && cd "$DST"
git clone http://github.com/denisidoro/navi
mkdir -p "$DST"
cd "$DST"
git clone https://github.com/denisidoro/navi
```
To enable navi, simply add it to the oh-my-zsh plugin array:
Then, add it to the oh-my-zsh plugin array:
```
# Sample ~/.zshrc
ZSHCFG="$HOME/.zsh"
ZSH="$ZSHCFG/oh-my-zsh"
ZSH_CUSTOM="$ZSHCFG"
plugins=(archlinux docker compleat git github gpg-agent ssh-agent nvm tmux fzf workon navi)
plugins=(docker tmux fzf navi)
# ...
source "$ZSH/oh-my-zsh.sh"
```
Then use it with `Alt-G`.
Finally, you can use it as a [shell widget](#shell-widget).
This method has the following advantages:
- No PATH modification
- No root install required
This method has the advantage of not requiring root to install and disadvantage of not allowing you to invoke the script by calling `navi` (unless you add an alias to it or copy it to a folder in `$PATH`).
Upgrading
---------
@ -96,6 +92,7 @@ Upgrading
- brew: `brew update; brew reinstall navi`
- git: `cd /opt/navi && sudo make update`
- oh-my-zsh: `cd "$(navi home)" && sudo make update`
Usage
-----

View file

@ -1,11 +0,0 @@
_call_navi() {
local buff="$BUFFER"
zle kill-whole-line
local cmd="$(NAVI_USE_FZF_ALL_INPUTS=true navi --print <> /dev/tty)"
zle -U "${buff}${cmd}"
# zle accept-line
}
zle -N _call_navi
bindkey '\eg' _call_navi

View file

@ -97,7 +97,7 @@ handler::widget() {
local widget
case "$SH" in
zsh) widget="${SCRIPT_DIR}/shell/widget.zsh" ;;
zsh) widget="${SCRIPT_DIR}/navi.plugin.zsh" ;;
*) echoerr "Invalid shell: $SH"; exit 1 ;;
esac
@ -144,4 +144,4 @@ main() {
handler::main
;;
esac
}
}