# Basic bash "library"

* The idea of this is to provide basic convenience settings in a Bash script.


## How to use

* Install `src/basic.bash` to `/path/to/basic.bash.`
* At the very beginning of a script (after the shebang):
  `source /path/to/basic.bash || exit 1`
* If a script includes (`source`s) other libraries, these should be included
  after `basic.bash`, which will then also apply to those.
* The `basic.bash` library should not be included in other libraries, except
  when these are meant as wrappers of `basic.bash`, providing additional
  functionality.
    * I.e., `basic.bash` should not be included more than once (while it
      should be safe to do so).
* Alternatively, one could also copy the content of `basic.bash` to the top
  (after the shebang) of a script.


## Semantics

* See [basic.bash](src/basic.bash) and [Error handling](doc/error-handling.md).