aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2022-10-27 23:43:18 +0200
committerTeddy Wing2022-10-27 23:43:18 +0200
commitfa5b3d7f1eeaa13b82284e6c27ddc93c1d6f0f2d (patch)
treea09a0eb0b65df768b7755f53a92e6837f0a89749
parent059f9c799e4486fa63a633c2b57257aebbb8547e (diff)
downloadSSVLSystemAlertVolume-fa5b3d7f1eeaa13b82284e6c27ddc93c1d6f0f2d.tar.bz2
README: Add project description and usage information
-rw-r--r--Alert volume slider.pngbin0 -> 13079 bytes
-rw-r--r--README.md19
2 files changed, 11 insertions, 8 deletions
diff --git a/Alert volume slider.png b/Alert volume slider.png
new file mode 100644
index 0000000..bdbd9b0
--- /dev/null
+++ b/Alert volume slider.png
Binary files differ
diff --git a/README.md b/README.md
index 65e6824..e5eb8d7 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,22 @@
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.
+A library to access the system alert volume on Mac OS X. The alert volume 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.
+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.
+
+![Alert volume slider in the Sound preference pane](./Alert volume slider.png)
## Use
-TODO
+Include the two files “SSVLSystemAlertVolume.h” and “SSVLSystemAlertVolume.c”
+in your project directly, via submodule, or another means.
-[[See the example](./example/main.c) for …]
+[See the example](./example/main.c) for an illustration of how to use the
+library.
## License