coffee.baz-plugin/README.md
Ari Archer d1fcd38a4a
Add more info to readme
Signed-off-by: Ari Archer <ari.web.xyz@gmail.com>
2022-06-08 20:43:36 +03:00

41 lines
1,021 B
Markdown

# Baz plugin: coffee.baz-plugin
> Baz plugin for coffee theme in bash prompt
# Installation
- Using [baz plugin manager](https://ari-web.xyz/gh/baz):
```bash
$ baz install git 'https://github.com/coffee-theme/coffee.baz-plugin'
```
# Dependencies
- GNU coreutils
- (Optional) git -- show git branch
- (Optional) virtualenv -- show current virtual environment
# Looks
![Screenshot](/screenshot.jpg)
# Customisation
- `COFFEE_ROOT_CHAR` -- The character to use for the `root` user as the prompt [`#`]
- `COFFEE_CLR_USER` -- The colour to use for the normal user [`green`]
- `COFFEE_USER_CHAR` -- The character to use for the normal user as the prompt [`%`]
- `COFFEE_CLR_ERR` -- The error colour [`red`]
- `COFFEE_CLR_VENV` -- The colour to use for virtual environments [`green`]
- `COFFEE_CLR_ROOT` -- The user colour for the `root` user [`red`]
# Colours
The colours are not automatically escaped, to escape them
you can use `printf` or smt:
E.g.
```bash
export COFFEE_CLR_USER="$(printf "\033[0;33m")"
```