diff options
| author | evgeny <me@ch1p.com> | 2016-07-03 20:34:36 +0300 |
|---|---|---|
| committer | evgeny <me@ch1p.com> | 2016-07-03 20:34:36 +0300 |
| commit | bc5dd88104f02cc0b8dcbde50e07e870a862b5a0 (patch) | |
| tree | d5683e9579ea131b05bb0d69750bd38de0a3f7c2 | |
| parent | 1e76b09595fc9ba46d725debcb08c3f5d0dd6275 (diff) | |
add README
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1bbc4c --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# alsa-volume-monitor + +`alsa-volume-monitor` is a simple program written in C that listens to ALSA events and emits a DBus signal when something has been changed (e.g. volume). + +It was created for use with Awesome WM in volume indicator widgets. + +### Usage +`./alsa-volume-monitor hw:0`, where `hw:0` is the name of your audio card. + +### Catch events from Awesome config + +``` +dbus.request_name("session", "com.ch1p.avm") +dbus.add_match("session", "interface='com.ch1p.avm',member='valueChanged'") +dbus.connect_signal("com.ch1p.avm", function(...) + -- Update your widget here + end +) +``` + +### License +GPLv2 |