updated readme, sorted includes, added comments
This commit is contained in:
17
README.md
17
README.md
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user