mirror of https://gitlab.com/ceda_ei/wish
Update README
This commit is contained in:
parent
425ddc114e
commit
9944da2b92
34
README.md
34
README.md
|
@ -20,36 +20,6 @@ WISH_THEME=plain
|
||||||
source ~/.config/wish/wish.sh
|
source ~/.config/wish/wish.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
# Customization
|
# Wiki
|
||||||
|
|
||||||
+ To change the order of plugins, edit the `WISH_PLUGINS` array.
|
[Check the wiki for details about customization and plugins.](https://gitlab.com/ceda_ei/wish/wikis/home)
|
||||||
+ To change the theme, edit the `WISH_THEME` variable.
|
|
||||||
+ To enable/disable powerline fonts, set `WISH_POWERLINE` to `1` or `0`.
|
|
||||||
|
|
||||||
## Example config
|
|
||||||
|
|
||||||
```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: &
|
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 19 KiB |
Loading…
Reference in New Issue