diff --git a/README.md b/README.md index 573aa52..5625a1f 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,25 @@ ## Installation -### Requirements -* bash 4+ (OSX: `brew install bash`) -* GNU sed (OSX: `brew install gnu-sed --with-default-names`) -* GNU getopt (OSX: `brew install gnu-getopt --with-default-names`) +### Dependencies + +#### Required + +* bash 4+ + + * Install on OSX: `brew install bash` + +#### Recommended + +* GNU sed + + * Avoids creation of `.bak` files in strange places on OSX + * Install on OSX: `brew install gnu-sed --with-default-names` + +* GNU getopt + + * Required to use long named switches, like --version or --help instead of -v and -h. + * Install on OSX: `brew install gnu-getopt --with-default-names` ### Install