Updated README and help string.

Former-commit-id: 3121ed9
hcr923fm · Feb 26, 2017 · 7aeb52b · 7aeb52b
1 parent edcc49c
commit 7aeb52b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 Chronicle is an audio logger, designed for radio station use.
 
-At the moment, it records audio from the default input to an audio file, on the hour, every hour. Once the recordings have become outdated, they will be deleted. As such, it is a full rotating logger.
+At the moment, it records audio from specified input to an audio file, on the hour, every hour. Once the recordings have become outdated, they will be deleted. As such, it is a full rotating logger.
 
 
 ## Usage:
@@ -24,9 +24,8 @@ Where:
 ## Buy me a coffee?
 If you find chronicle to be useful, fancy buying me a coffee?
 
-I'm on Flattr:
-[![Flattr this!](//button.flattr.com/flattr-badge-large.png)](https://flattr.com/submit/auto?fid=kzr39z&url=http%3A%2F%2Fgithub.com%2Fcalmcl1%2Fchronicle)
+I'm on [Flattr](https://flattr.com/submit/auto?fid=kzr39z&url=http%3A%2F%2Fgithub.com%2Fcalmcl1%2Fchronicle)!
 
 ## Copyright
 Copyright 2016-2017 Callum McLean.
-Distributed under the MIT Licence.
+Distributed under the MIT Licence. See LICENCE for details.
diff --git a/chronicle.cpp b/chronicle.cpp
@@ -444,17 +444,24 @@ void printHelp() {
 	const char USAGE[] =
 		R"(
 Usage:
-    chronicle [-h | --help] [--licence] [-d | --directory OUTPUT_DIRECTORY] [-f | --filename FORMAT]
-        [-a | --max-age MAX_FILE_AGE] [-s | --audio-format [WAV | OGG]]
+    chronicle [-h | --help]
+    chronicle [--licence]
+    chronicle [-l | --list-devices ]
+    chronicle [-d | --directory OUTPUT_DIRECTORY] [-f | --filename FORMAT] [-i | --input-device DEVICE_ID] 
+              [-a | --max-age MAX_FILE_AGE] [-s | --audio-format [WAV | OGG]]
 
     Where:
         -h | --help          Prints this help message.
         --licence            Prints the licence information for this software and libraries that it uses.
+        -l | --list-devices  Lists the available input devices with their IDs.
         -d | --directory     Sets the directory to save the logged audio to. A trailing slash is not required, but may
                                  be added. On Windows, if using a trailing slash, use a trailing double-slash.
                                  Defaults to current directory.
         -f | --format        strftime-compatible format to use when naming the audio files.
                                  Defaults to %F %H%M%S .
+        -i | --input-device  The ID number of the input device to record from. A list of input devices and their ID
+                                 numbers can be obtained with `chronicle -l`.
+                                 If unspecified, the system default audio recording device will be used.
         -a | --max-age       Sets the maximum age (in seconds) before audio files will be automatically deleted.
                                  Defaults to 216000000 (1000 hours, in accordance with OFCOM rules).
         -s | --audio-format Sets the audio format to use for the recorded audio files.