Initialize repo, add BSD 3-clause license

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b0dc96f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Volsv
+
+#### What is it?
+
+Volsv is a POSIX-compliant shell script I wrote in 2020, and have been modifying since. Presently, it supports:
+
+- Increasing volume
+- Decreasing volume
+- Toggling the interface mute
+- Toggling the microphone mute\*
+
+in both pulseaudio and ALSA\*. Once I get OpenBSD and FreeBSD up and running, I will add those sound options too.
+
+It depends on:
+
+- pamixer (pulseaudio)
+- amixer (alsa)
+- pgrep (with the -x command, standard in BSD and \*/Linux systems)
+
+#### But *why* though?
+
+I made volsv so that I could use it with keybindings to control the volume, regardless of whether or not I was running pulseaudio, since I dislike pulseaudio and tend to avoid it when possible. This means I can have a consistent keybinding, whether or not I'm using it. Additionally, this would give me less keybindings to have to port to OpenBSD, which I occasionally install from time to time, although I haven't booted into it since I started writing this script. Additionally, it has provided a fun learning experience as I learn to write scripts.
+
+
+
+\*Volsv does not yet support muting the microphone in ALSA.