From c6773044e05d5e4506bbcbe922cf86b05787eec8 Mon Sep 17 00:00:00 2001 From: trscavo Date: Thu, 13 Oct 2016 18:10:01 -0400 Subject: [PATCH] Create README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..06a0d95 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Bash Library + +A library of re-usable bash scripts + +## Installation + +Download the source, change directory to the source directory, and install the source into ``/tmp`` as follows: + +```Shell +$ export BIN_DIR=/tmp/bin +$ export LIB_DIR=/tmp/lib +$ ./install.sh $BIN_DIR $LIB_DIR +``` + +or install into your home directory: + +```Shell +$ export BIN_DIR=$HOME/bin +$ export LIB_DIR=$HOME/lib +$ ./install.sh $BIN_DIR $LIB_DIR +``` + +An installation directory will be created if it doesn't already exist. + +## Compatibility + +These scripts are compatible with GNU/Linux and Mac OS. + +## Dependencies + +None