summaryrefslogtreecommitdiff
path: root/mpris-widget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2020-11-30 15:32:37 -0500
committerGitHub <noreply@github.com>2020-11-30 15:32:37 -0500
commit10c237ce14585f548380b76be73803e5e54d8aa7 (patch)
tree61a3593ba313e1560ed5aad8ca0093308e8bdefa /mpris-widget/README.md
parent1c957ffc8a68081a56d20951050f9af83cac3c25 (diff)
parent062a6d77628647d26a92126a3484907115e7fa3b (diff)
Merge pull request #213 from mgabs/master
adding an mpris widget
Diffstat (limited to 'mpris-widget/README.md')
-rw-r--r--mpris-widget/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/mpris-widget/README.md b/mpris-widget/README.md
new file mode 100644
index 0000000..317385f
--- /dev/null
+++ b/mpris-widget/README.md
@@ -0,0 +1,26 @@
+# MPRIS Widget
+
+Music Player Info widget cy @mgabs
+
+# Prerequisite
+
+Install `playerctl` (mpris implementation), should be available in repo, e.g for Ubuntu:
+
+```bash
+sudo apt-get install playerctl
+```
+
+## Installation
+
+To use this widget clone repo under **~/.config/awesome/** and then add it in **rc.lua**:
+
+```lua
+local mpris_widget = require("awesome-wm-widgets.mpris-widget")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ mpris_widget,
+ ...
+```