awesomewm-mirrors
/
vicious
mirror of https://github.com/vicious-widgets/vicious.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

restructured README.md

This commit is contained in:
mutlusun 2016-12-21 16:04:35 +01:00
parent 80cf499237
commit 82f9e8970d
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -146,19 +146,20 @@ argument given to vicious.register as the first argument, *warg* as
the second, and return a table of values to insert in the format
string.
**Battery**
**vicious.widgets.bat**
- `vicious.widgets.bat`: Battery widget for GNU/Linux
- provides state, charge, and remaining time for a requested battery
- takes battery ID as an argument, i.e. "BAT0"
- returns 1st value as state of requested battery, 2nd as charge
level in percent, 3rd as remaining (charging or discharging)
time and 4th as the wear level in percent
- `vicious.widgets.bat_freebsd`: Battery widget for FreeBSD
- provides state, charge, and remaining time for a battery
- returns 1st value as state of requested battery, 2nd as charge
level in percent, 3rd as remaining (charging or discharging)
time and 4th as the wear level in percent
Provides state, charge, and remaining time for a requested battery.
Supported platforms: Linux, FreeBSD.
- Arguments (per platform):
- Linux: takes battery ID as an argument, i.e. "BAT0"
- FreeBSD: no arguments needed
- Returns (per platform):
- Linux: returns 1st value as state of requested battery, 2nd as charge
level in percent, 3rd as remaining (charging or discharging) time and 4th
as the wear level in percent
- FreeBSD: see Linux, but wear level is not supported right now and always
set to `0`
**vicious.widgets.cpu**