From 25d9eecfc68df3251dc96008aaa4cd7c81900da6 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Fri, 19 Mar 2021 20:49:00 -0400
Subject: [volume] BREAKING CHANGE - new widget instead of old ones

Having three widgets for volume led to a problem of code duplication -
same logic was duplicated three times. However when an issue was
discovered and fixed, it was fixed in only one of three widgets.
So I decided to create a volume widget from scratch, adding new
features, such as selecting input/output, better responsiveness,
easily customizable widget ui (bar, text, icon, icon and text, arc).
Should close #199, #198, #185, #182, #47, #122, #183.
---
 volumearc-widget/README.md | 69 ----------------------------------------------
 1 file changed, 69 deletions(-)
 delete mode 100644 volumearc-widget/README.md

(limited to 'volumearc-widget/README.md')

diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md
deleted file mode 100644
index 496797e..0000000
--- a/volumearc-widget/README.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# Volumearc widget
-
-Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using [arcchart](https://awesomewm.org/doc/api/classes/wibox.container.arcchart.html):
-
-![screenshot](./out.gif)
-
-Supports 
- - scroll up - increase volume, 
- - scroll down - decrease volume, 
- - left click - mute/unmute.
-
-## Customization
-
-It is possible to customize widget by providing a table with all or some of the following config parameters:
-
-| Name | Default | Description |
-|---|---|---|
-| `main_color` | `beautiful.fg_normal` | Color of the arc |
-| `bg_color` | `#ffffff11` | Color of the arc's background |
-| `mute_color` | `beautiful.fg_urgent` | Color of the arc when mute |
-| `path_to_icon` | /usr/share/icons/Arc/status/symbolic/audio-volume-muted-symbolic.svg | Path to the icon |
-| `thickness` | 2 | The arc thickness |
-| `height` | `beautiful.fg_normal` | Widget height |
-| `timeout` | 1 | How often in seconds the widget refreshes |
-| `get_volume_cmd` | `amixer -D pulse sget Master` | Get current volume level |
-| `inc_volume_cmd` | `amixer -D pulse sset Master 5%+` | Increase volume level |
-| `dec_volume_cmd` | `amixer -D pulse sset Master 5%-` | Decrease volume level |
-| `tog_volume_cmd` | `amixer -D pulse sset Master toggle` | Mute / unmute |
-| `button_press` | `function(_, _, _, button) <sane default logic> end` | Overwrite the 'button\_press' signal for this widget |
-
-### Example:
-
-```lua
-volumearc_widget({
-    main_color = '#af13f7',
-    mute_color = '#ff0000',
-    thickness = 5,
-    height = 25,
-    button_press = function(_, _, _, button)   -- Overwrites the button press behaviour to open pavucontrol when clicked
-        if (button == 1) then awful.spawn('pavucontrol --tab=3', false)
-        end
-    end
-})
-```
-
-The config above results in the following widget:
-
-![custom](./custom.png) 
-
-## Installation
-
-1. Clone this repo under **~/.config/awesome/**
-
-    ```bash
-    git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/awesome-wm-widgets
-    ```
-
-1. Require volumearc widget at the beginning of **rc.lua**:
-
-```lua
-local volumearc_widget = require("awesome-wm-widgets.volumearc-widget.volumearc")
-...
-s.mytasklist, -- Middle widget
-	{ -- Right widgets
-    	layout = wibox.layout.fixed.horizontal,
-		...
-		volumearc_widget(),
-		...
-```
-- 
cgit v1.2.3