summaryrefslogtreecommitdiff
path: root/BatteryWidget/README.md
blob: 8ffa36400ee21018d27823dc870149a581808eb7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
## Battery widget
Simple and easy-to-install widget for Awesome Window Manager.

This widget consists of 

 - an icon which shows the battery status: ![Battery Widget](./batWid1.png)
 - a pop-up window, which shows up when you hover over it: ![Battery Widget](./batWid2.png)
 - a pop-up warning message which appears when battery level is less that 15%. 

## Installation

This widget uses the output of acpi tool.
- install `acpi` tool:
```
sudo apt-get install acpi
```
- clone/copy battery.lua file and battery-icons folder to your ~/home/username/.config/awesome/ folder;

- change path to the icons in `battery.lua`;

- include `battery.lua` and add battery widget to your wibox in rc.lua:
```
require("battery")
...
right_layout:add(batteryIcon)
```