Update bootstrap.sh docstring

This commit is contained in:
Andrejus
2020-02-26 15:09:45 +00:00
parent 9ee236cbb7
commit 62b6c92e0c

View File

@@ -2,9 +2,33 @@
#
# Script to set up and install dotfiles repository.
#
# Installs git using apt-get if not in $PATH.
# Pulls latest dotfiles repository.
#
#
# Usage:
# `source path/to/bootstrap.sh`
# `source <(wget path/to/bootstrap.sh)`
#
# i. Source into existing bash shell.
#
# $ source bootstrap.sh
# $ source path/to/bootstrap.sh
# $ source <(wget path.to/bootstrap.sh)
#
# ii. Run in new bash shell.
#
# $ bash bootstrap.sh
# $ bash path/to/bootstrap.sh
# $ bash <(wget path.to/bootstrap.sh)
#
#
# Configuration:
#
# $REPOSITORY - GitHub repository to clone and run $dir/install.sh of
# @default "andrejusk/dotfiles"
#
# $WORKSPACE - parent directory to clone repository in to
# @default "$HOME/workspace"
#
#
set -o pipefail
echo "setting up..."