diff options
author | Teddy Wing | 2022-10-27 23:43:18 +0200 |
---|---|---|
committer | Teddy Wing | 2022-10-27 23:43:18 +0200 |
commit | fa5b3d7f1eeaa13b82284e6c27ddc93c1d6f0f2d (patch) | |
tree | a09a0eb0b65df768b7755f53a92e6837f0a89749 /README.md | |
parent | 059f9c799e4486fa63a633c2b57257aebbb8547e (diff) | |
download | SSVLSystemAlertVolume-fa5b3d7f1eeaa13b82284e6c27ddc93c1d6f0f2d.tar.bz2 |
README: Add project description and usage information
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -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. + + ## 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 |