denis/gis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
Denis Lehmann 2023-09-27 12:29:18 +02:00
parent 6e78419971
commit 2d8c766536
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.org
View file

@ -27,8 +27,18 @@ It was inspired by [[https://wiki.ros.org/wstool][wstool]], [[https://github.com
* Installation
Place the =gis= script somewhere in your =$PATH= *or* use the provided =install.{bash,zsh}= scripts.
Those will create a symlink in =~/.local/bin= and update the respective =~/.{bash,zsh}rc=.
Place the =gis= script in your =$PATH=.
To use the autocompletion feature source the =gis_completion.bash= script.
On ZSH additionally the =compinit= and =bashcompinit= modules must be loaded before sourcing the completion script:
#+begin_src sh
autoload -U +X compinit && compinit
autoload -U +X bashcompinit && bashcompinit
#+end_src
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=.
** Nix Flake