summaryrefslogtreecommitdiff
path: root/volumearc-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'volumearc-widget/README.md')
-rw-r--r--volumearc-widget/README.md51
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:
-![screenshot](out.gif)
-
-Supports:
- - scroll up - increase volume,
- - scroll down - decrease volume,
- - left click - mute/unmute.
+![screenshot]({{'/assets/img/screenshots/volumearc-widget.gif' | relative_url }}){:.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