diff --git a/README.md b/README.md index 4d58584..103c819 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,22 @@ jingle plays. Running the program with no args will default to playing a jingle every 5 minutes. + +If `[player_program]` is specified (with full path) like with +`/usr/bin/ffplay`, then the command executed will look like: + + /usr/bin/ffplay + +If `[player_args...]` is specified like with `--flag` and `--another-flag`, then +the command executed will look like: + + /usr/bin/ffplay --flag --another-flag + +It may be recommended to use a command like: + + ./break_interval 5 /my/music/file.mp3 /usr/bin/ffplay -nodisp + +Which will execute (every 5 minutes): + + /usr/bin/ffplay -nodisp /my/music/file.mp3 +