Adding help messages and documentation

apel · Jan 17, 2024 · 87f1b65 · 87f1b65
1 parent 4a3570a
commit 87f1b65
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/scripts/3.4.5-3.tar.gz b/scripts/3.4.5-3.tar.gz
diff --git a/scripts/ssm-build-dual.sh b/scripts/ssm-build-dual.sh
@@ -5,11 +5,17 @@
 # @Author: Nicholas Whyatt (RedProkofiev@github.com)
 
 # Script runs well with FPM 1.14.2 on ruby 2.7.1, setuptools 51.3.3 on RHEL and Deb platforms
+# Download ruby (if you're locked to 2.5, use RVM) and then run:
+# sudo gem install fpm -v 1.14.2
+# ./ssm-build-dual.sh (deb | rpm) <version> <iteration> <python_root_dir> e.g.
+# ./ssm-build.dual.sh deb 3.4.0 1 /usr/lib/python3.6
+# For SSM 3.4.0 and up.  Versions before that would technically work, but the changelog
+# then was in a Debian format that doesn't parse and fails hard if you want to build RPM.
 
 set -e
 
 usage() { 
-    echo "Usage: $0 (deb | rpm) <version> <iteration> <python_root_dir> [options]"
+    echo "[options] Usage: $0 (deb | rpm) <version> <iteration> <python_root_dir> "
     echo -e "Build script for Apel-SSM.\n"
     echo "  -h                    Displays help."
     echo "  -v                    Verbose FPM output."