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 2025-09-11 13:11:49 +02:00 • committed by Denis Lehmann
parent 79ab269fe6
commit 0b555a668d
1 changed files with 63 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.org
View file

@ -44,6 +44,8 @@ It was inspired by [[https://wiki.ros.org/wstool][wstool]], [[https://github.com
Place the =gis= script in your =$PATH=.
To use the autocompletion feature source the =gis_completion.bash= script.
*** ZSH
On ZSH additionally the =compinit= and =bashcompinit= modules must be loaded before sourcing the completion script:
#+begin_src sh
@ -53,14 +55,23 @@ It was inspired by [[https://wiki.ros.org/wstool][wstool]], [[https://github.com
** 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=.
Installation scripts for Bash (=install.bash=) and ZSH (=install.zsh=) are provided which will link the two files from the current repository 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= in the /gis/ repository.
** Nix Flake
This repository is also a [[https://nixos.wiki/wiki/Flakes][Nix Flake]].
/gis/ is provided as package under =github:Deleh/gis#gis=.
* Configuration
The default behavior can be adjusted with the following environment variables:
| Variable | Description | Example Value |
|------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------|
| =GIS_PATH= | Colon seperated list of paths. If set, they will be used as default search paths instead of the current work directory. Can be overwritten with the =--path= argument. | =$HOME/git:$HOME/code= |
| =GIS_JOBS= | Limit for the number of parallel =fetch= and =pull= jobs. | =10= |
* Syntax
** Status Keys