added docs for powerup

diff --git a/scripts/site_avenger/powerup.sh b/scripts/site_avenger/powerup.sh
index 74982616718af62e7bbed3a278ad0b3e60196d0c..93ae3d4205eca3a93eb8794c566d3b1640ab710d 100644 (file)
--- a/scripts/site_avenger/powerup.sh
+++ b/scripts/site_avenger/powerup.sh
@@ -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"