aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..65e6824
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+SSVLSystemAlertVolume
+=====================
+
+TODO
+A library to access the system alert volume on Mac OS X. The alert volume
+is/controls the percentage output volume
+for beeps and sound effects.
+is set relative to the output volume, and is used for beeps and sound effects.
+
+This volume level is commonly set in the System Preferences’ Sound preference pane. Under the pane’s “Sound Effects” tab, it is controlled using the “Alert volume” slider.
+
+
+## Use
+TODO
+
+[[See the example](./example/main.c) for …]
+
+
+## License
+Copyright © 2022 Teddy Wing. Licensed under the Mozilla Public License v. 2.0
+(see the included LICENSE file).