From d79cc9727a5f0a0f9ce3f56c26d0175181ad1c28 Mon Sep 17 00:00:00 2001 From: streetturtle Date: Mon, 13 Jul 2015 18:37:31 +0200 Subject: readme --- BatteryWidget/README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'BatteryWidget/README.md') diff --git a/BatteryWidget/README.md b/BatteryWidget/README.md index 87d8078..5e86ed1 100644 --- a/BatteryWidget/README.md +++ b/BatteryWidget/README.md @@ -1,6 +1,24 @@ -# Battery widget -Simple and easy-to-install widget for Awesome Window Manager +## Battery widget +Simple and easy-to-install widget for Awesome Window Manager. Basically this widget consist of an icon which shows the battery status: ![Battery Widget](./batWid1.png) And a pop-up window, which shows when you hover over it: ![Battery Widget](./batWid2.png) + +## Installation + +This widget ueses the output of acpi tool. + +- install `acpi` tool: +- +{% highlight bash %} +sudo apt-get install acpi +{% endhighlight %} + +- clone/copy battery.lua file and battery-icons folder to your ~/home/username/.config/awesome/ folder; + +- add battery widget to your wibox in rc.lua: + +{% highlight lua%} +right_layout:add(batteryIcon) +{% endhighlight %} -- cgit v1.2.3