aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Smeding <tom.smeding@gmail.com>2020-06-06 13:42:30 +0200
committerTom Smeding <tom.smeding@gmail.com>2020-06-06 13:42:30 +0200
commit4f459271ec499582d3e1ed5cb7bcad297f00d6ca (patch)
tree036e64944ace755b860f246d5a364fe2a17aba3f /README.md
parent0b5fe0a11afd6003d4f4adfaf462392cfdba5e89 (diff)
Expand readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5465b83
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+`sound-manager` is a CLI interface for managing PulseAudio sinks (speakers),
+sink-inputs (programs producing sound), sources (microphones), and
+source-outputs (programs recording sound).
+
+Additionally, the `elusive-events.py` script can aid in setting e.g. the volume
+on very short-lived sound effects, like the terminal bel. Run
+`elusive-events.py -h` for usage info.