nice, first bit of auto-help
[feisty_meow.git] / scripts / site_avenger / powerup.sh
index 74982616718af62e7bbed3a278ad0b3e60196d0c..b5cd0a897d989410eba20b9ec5b6e2a308e809fa 100644 (file)
@@ -30,6 +30,22 @@ source "$WORKDIR/site_avenger.config"
 
 ############################
 
+function print_instructions()
+{
+  echo
+  echo "$(basename $0 .sh) [app dirname] [repository] [theme name]"
+  echo
+  echo "All parameters are optional, and intelligent guesses for them will be made."
+  echo
+  echo "app dirname: The folder where the app will be stored."
+  echo "repository: The name of the git repository (short version, no URL)."
+  echo "theme name: The name to use for the cakephp theme."
+  echo
+  exit 0
+}
+
+############################
+
 # main body of script.
 
 # check for parameters.
@@ -37,6 +53,10 @@ app_dirname="$1"; shift
 repo_name="$1"; shift
 theme_name="$1"; shift
 
+if [ "$app_dirname" == "-help" -o "$app_dirname" == "--help" ]; then
+  print_instructions
+fi
+
 sep
 
 check_application_dir "$APPLICATION_DIR"
@@ -66,12 +86,12 @@ sep
 
 # this should set the site_store_path variable if everything goes well.
 update_repo "$full_app_dir" "$CHECKOUT_DIR_NAME" "$DEFAULT_REPOSITORY_ROOT" "$repo_name"
-check_result "Updating the repository storage directory"
+test_or_fail "Updating the repository storage directory"
 
 # update the site to load dependencies.
 sep
 composer_repuff "$site_store_path"
-check_result "Installing site dependencies with composer"
+test_or_fail "Installing site dependencies with composer"
 
 # set up the symbolic links needed to achieve siteliness.
 sep