diff --git a/README.org b/README.org index d4e8349..8671f69 100644 --- a/README.org +++ b/README.org @@ -27,18 +27,22 @@ It was inspired by [[https://wiki.ros.org/wstool][wstool]], [[https://github.com * Installation - Place the =gis= script in your =$PATH=. - To use the autocompletion feature source the =gis_completion.bash= script. +** Manual - On ZSH additionally the =compinit= and =bashcompinit= modules must be loaded before sourcing the completion script: + Place the =gis= script in your =$PATH=. + To use the autocompletion feature source the =gis_completion.bash= script. - #+begin_src sh - autoload -U +X compinit && compinit - autoload -U +X bashcompinit && bashcompinit - #+end_src + On ZSH additionally the =compinit= and =bashcompinit= modules must be loaded before sourcing the completion script: - Alternatively, installation scripts for Bash (=install.bash=) and ZSH (=install.zsh=) are provided which will link the two files to =~/.local/{bin/gis,share/bash-completion/completions/gis}= and add the corresponding entries to =~/.bashrc= or =~/.zshrc=. - Further updates of /gis/ require just =git pull=. + #+begin_src sh + autoload -U +X compinit && compinit + autoload -U +X bashcompinit && bashcompinit + #+end_src + +** Scripts + + Installation scripts for Bash (=install.bash=) and ZSH (=install.zsh=) are provided which will link the two files to =~/.local/{bin/gis,share/bash-completion/completions/gis}= and add the corresponding entries to =~/.bashrc= or =~/.zshrc=. + Further updates of /gis/ require just =git pull=. ** Nix Flake