add README

This commit is contained in:
evgeny 2016-07-03 20:34:36 +03:00
parent 1e76b09595
commit bc5dd88104

22
README.md Normal file
View File

@ -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