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