summaryrefslogtreecommitdiff
path: root/VolumeWidget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'VolumeWidget/README.md')
-rw-r--r--VolumeWidget/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/VolumeWidget/README.md b/VolumeWidget/README.md
new file mode 100644
index 0000000..2c4a717
--- /dev/null
+++ b/VolumeWidget/README.md
@@ -0,0 +1,15 @@
+## Volume widget
+Simple and easy-to-install widget for Awesome Window Manager.
+
+This widget represents the sound level: ![Volume Wiget](./volWid.png)
+
+## Installation
+
+- clone/copy volume.lua file and volume-icons folder to your `~/home/username/.config/awesome/` folder;
+
+- include `volume.lua` and add volume widget to your wibox in rc.lua:
+```
+require("volume")
+...
+right_layout:add(volumeWidget)
+```