updated readme, sorted includes, added comments

This commit is contained in:
2025-11-15 16:42:15 +01:00
parent 67ac6804a4
commit dd95410d36
3 changed files with 13 additions and 11 deletions

View File

@@ -1,17 +1,16 @@
## countdown
Simple command line countdown timer that plays a sound when the time is up.
It is using `pulseaudio`s simple API.
When the time has expired a square wave is sent to `pulseaudio`s simple API \
to notify the user.
#### installation
install `libpulse-dev` (debian based) or `libpulse` package depending on your distro
Install `libpulse-dev` (debian based) or `libpulse` package depending on your distribution.
```
sudo pacman -S libpulse pulseaudio sound-theme-freedesktop
```
```
ffmpeg -i /usr/share/sounds/freedesktop/stereo/alarm-clock-elapsed.oga ${HOME}/music/alarm-clock-elapsed.wav
sudo pacman -S libpulse pulseaudio
```
```
@@ -23,6 +22,7 @@ sudo make install
#### usage
Start a 20 minute countdown:
```
countdown 20
```
@@ -35,5 +35,4 @@ sudo make uninstall
#### TODO
- make alarm clock file wave file configurable
- fix still reachable bytes (still reachable: 42,485 bytes in 97 blocks)?
- Arch Linux package