mirror of https://gitlab.com/ceda_ei/wish
Update README
This commit is contained in:
parent
2abbb59e94
commit
5f90303bb1
24
README.md
24
README.md
|
@ -14,7 +14,7 @@ A customizable bash prompt.
|
|||
+ `git clone https://gitlab.com/ceda_ei/wish.git`
|
||||
+ Add the following lines to ~/.bashrc
|
||||
|
||||
```
|
||||
```bash
|
||||
WISH_PLUGINS=(exit_code_smiley bg_jobs date path newline vcs)
|
||||
WISH_THEME=plain
|
||||
source ~/.config/wish/wish.sh
|
||||
|
@ -28,10 +28,28 @@ source ~/.config/wish/wish.sh
|
|||
|
||||
## Example config
|
||||
|
||||
![Example Config](screenshots/example_config.png)
|
||||
```
|
||||
```bash
|
||||
WISH_DATE_FORMAT="%d %b %H:%M" # Look in date plugin for details
|
||||
WISH_PLUGINS=(newline exit_code bg_jobs tmux date battery path python_venv newline vcs space)
|
||||
WISH_POWERLINE=1
|
||||
WISH_THEME=rgb_gradient
|
||||
```
|
||||
|
||||
![Example Config](screenshots/example_config.png)
|
||||
|
||||
|
||||
# List of Plugins
|
||||
|
||||
## Battery
|
||||
|
||||
+ Plugin Name: `battery`
|
||||
+ Config Variables
|
||||
+ `WISH_BATTERY_ID`: ID of Battery to check. Default: `BAT0`
|
||||
+ `WISH_BATTERY_CHARGING`: Symbol while the battery is charging. Default: ϟ
|
||||
+ `WISH_BATTERY_DISCHARGING`: Symbol while the battery is discharging. Default: ⏚
|
||||
|
||||
## Background Jobs
|
||||
|
||||
+ Plugin Name: `bg_jobs`
|
||||
+ Config Variables
|
||||
+ `WISH_BG_JOBS_SUFFIX`: Suffix to add to number of background jobs. Default: &
|
||||
|
|
Loading…
Reference in New Issue