scripts/library: add README file

Add a README file to briefly document the code snippets in the scripts
library folder.

Signed-off-by: Allan McRae <allan@archlinux.org>
Signed-off-by: Dan McGee <dan@archlinux.org>

1 files changed, 15 insertions, 0 deletions

diff --git a/scripts/library/README b/scripts/library/README
new file mode 100644
index 00000000..1e9c962b
--- /dev/null
+++ b/scripts/library/README
@@ -0,0 +1,15 @@
+This folder contains code snippets that can be reused by multiple
+scripts.  A brief description of each file follows.
+
+output_format.sh:
+Provides basic output formatting functions with levels 'msg', 'msg2',
+'warning' and 'error'.  The 'msg' amd 'msg2' functions print to stdout
+and can be silenced by defining 'QUIET'.  The 'warning' and 'error'
+functions print to stderr with the appropriate prefix added to the
+message.
+
+parse_options.sh:
+A getopt replacement to avoids portability issues, in particular the
+lack of long option name support in the default getopt provided by some
+platforms.
+Usage: parse_option $SHORT_OPTS $LONG_OPTS "$@"