diff options
| author | Augusto Gunsch <augustogunsch@tutanota.com> | 2022-01-23 21:41:44 -0300 |
|---|---|---|
| committer | Augusto Gunsch <augustogunsch@tutanota.com> | 2022-01-23 21:41:44 -0300 |
| commit | 56c8e3439b43f819f7a73bd075737ce93d38e5ef (patch) | |
| tree | 9e9261905165b9294f8242a95acc837c52306b69 /cmus-widget/README.md | |
| parent | ac49ade9951b591e859a470803e166acfa2b7bf2 (diff) | |
Add cmus widget
Diffstat (limited to 'cmus-widget/README.md')
| -rw-r--r-- | cmus-widget/README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/cmus-widget/README.md b/cmus-widget/README.md new file mode 100644 index 0000000..c24d975 --- /dev/null +++ b/cmus-widget/README.md @@ -0,0 +1,48 @@ +# Cmus widget + +Cmus widget that shows the current playing track. + + + +Left click toggles playback. + +## Installation + +Clone the repo under **~/.config/awesome/** and add widget in **rc.lua**: + +```lua +local cmus_widget = require('awesome-wm-widgets.cmus-widget.cmus') +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + -- default + cmus_widget(), + -- customized + cmus_widget{ + space = 5, + timeout = 5 + }, +``` + +### Shortcuts + +To improve responsiveness of the widget when playback is changed by a shortcut use corresponding methods of the widget: + +```lua +awful.key({ modkey, "Shift" }, "p", function () cmus_widget:play_pause() end, {description = "play/pause cmus", group = "custom"}), +``` + +## Customization + +It is possible to customize the widget by providing a table with all or some of the following config parameters: + +### Generic parameter + +| Name | Default | Description | +|---|---|---| +| `font` | `Play 9` | Font used for the track title | +| `path_to_icons` | `/usr/share/icons/Arc/actions/symbolic/` | Alternative path for the icons | +| `timeout`| `10` | Refresh cooldown | +| `space` | `3` | Space between icon and track title | |