diff options
author | streetturtle <streetturtle@gmail.com> | 2017-02-01 20:52:08 -0500 |
---|---|---|
committer | streetturtle <streetturtle@gmail.com> | 2017-02-01 20:52:08 -0500 |
commit | a333acf17e0fc21104799daee8ea3ed7cb3f833f (patch) | |
tree | 5189281a7c46f891070633375b8fad2a13cd0c2b /battery-widget/README.md | |
parent | a1fe01e1ad194b05319b00c96ebdc4d059652392 (diff) |
Battery widget readme
Diffstat (limited to 'battery-widget/README.md')
-rw-r--r-- | battery-widget/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/battery-widget/README.md b/battery-widget/README.md new file mode 100644 index 0000000..eee4e99 --- /dev/null +++ b/battery-widget/README.md @@ -0,0 +1,34 @@ +# Battery widget +Simple and easy-to-install widget for Awesome Window Manager. + +This widget consists of + + - an icon which shows the battery level: ![Battery Widget](./bat-wid-1.png) + - a pop-up window, which shows up when you hover over an icon: ![Battery Widget](./bat-wid-2.png) + - a pop-up warning message which appears on bottom right corner when battery level is less that 15%: ![Battery Widget](./bat-wid-3.png) + +## Installation + +This widget reads the output of acpi tool. +- install `acpi` and check the output: + +```bash +$ sudo apt-get install acpi +$ acpi +Battery 0: Discharging, 66%, 02:34:06 remaining +``` + +- clone/copy battery.lua file to ~/.config/awesome/ folder; + +- include `battery.lua` and add battery widget to your wibox in rc.lua: + +```lua +require("battery") +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + battery_widget, + ... +```
\ No newline at end of file |