From 62b6c92e0cdb7517abd684efe8fff3e8ab644370 Mon Sep 17 00:00:00 2001 From: Andrejus Date: Wed, 26 Feb 2020 15:09:45 +0000 Subject: [PATCH] Update bootstrap.sh docstring --- bootstrap.sh | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/bootstrap.sh b/bootstrap.sh index 3978ebe..12706a4 100644 --- a/bootstrap.sh +++ b/bootstrap.sh @@ -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..."