summaryrefslogtreecommitdiff
path: root/BatteryWidget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2015-07-13 22:57:51 +0200
committerstreetturtle <streetturtle@gmail.com>2015-07-13 22:57:51 +0200
commit2bb629502934e394642e4861e0ad2abd6f44e249 (patch)
tree528d146e83d0efe31c85633eee5953045654c66c /BatteryWidget/README.md
parent5d3e23efe20ef50f4d6721ef9473fc311d5d21a3 (diff)
parentb874b717c915070e4bf7b3ad56aa076a5ca0126b (diff)
Merge branch 'master' of https://github.com/streetturtle/AwesomeWM
Diffstat (limited to 'BatteryWidget/README.md')
-rw-r--r--BatteryWidget/README.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/BatteryWidget/README.md b/BatteryWidget/README.md
index 5e86ed1..fa3925e 100644
--- a/BatteryWidget/README.md
+++ b/BatteryWidget/README.md
@@ -1,24 +1,22 @@
## 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)
+Basically this widget consists 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)
+And a pop-up window, which shows up when you hover over it: ![Battery Widget](./batWid2.png)
## Installation
-This widget ueses the output of acpi tool.
-
+This widget uses 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%}
+- include `battery.lua` and add battery widget to your wibox in rc.lua:
+```
+require("battery")
+...
right_layout:add(batteryIcon)
-{% endhighlight %}
+```