diff options
| author | streetturtle <streetturtle@gmail.com> | 2019-03-30 17:42:59 -0400 |
|---|---|---|
| committer | streetturtle <streetturtle@gmail.com> | 2019-04-13 20:52:16 -0400 |
| commit | cf75c446e10ebf720df114e1d040a5c4730c21c3 (patch) | |
| tree | 7f9e79f1c87e04f0528d03e1e0252fad8d8cf520 /volumearc-widget/README.md | |
| parent | 54924ef0645c8b7b212066670e00a164c280ed2f (diff) | |
volumearc - externalize config
Diffstat (limited to 'volumearc-widget/README.md')
| -rw-r--r-- | volumearc-widget/README.md | 51 |
1 files changed, 33 insertions, 18 deletions
diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md index 702b486..79f519d 100644 --- a/volumearc-widget/README.md +++ b/volumearc-widget/README.md @@ -2,24 +2,39 @@ Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using arcchart: - - -Supports: - - scroll up - increase volume, - - scroll down - decrease volume, - - left click - mute/unmute. +{:.center-image} ## Installation -Clone repo, include widget and use it in **rc.lua**: - -```lua -require("volumearc") -... -s.mytasklist, -- Middle widget - { -- Right widgets - layout = wibox.layout.fixed.horizontal, - ... - volumearc_widget, - ... -``` +1. Clone this repo under **~/.config/awesome/** + + ```bash + git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/ + ``` + +1. Require volumearc widget at the beginning of **rc.lua**: + + ```lua + local volumearc_widget = require("awesome-wm-widgets.volumearc-widget.volumearc") + ``` + +1. Add widget to the tasklist: + + ```lua + s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + --[[default]] + volumearc_widget(), + --[[or customized]] + volumearc_widget({ + main_color = '#0000ff', + mute_color = '#ff0000', + path_to_icon = '/usr/share/icons/Arc/actions/symbolic/view-grid-symbolic.svg', + thickness = 5, + height = 25 + }), + + ... + ```
\ No newline at end of file |