add some comments

flaxandteal · Oct 17, 2024 · 5608b01 · 5608b01
1 parent 8c05eae
commit 5608b01
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/create_env_and_build.sh b/create_env_and_build.sh
@@ -1,5 +1,13 @@
 #!/bin/bash
 
+# The script expects exactly one argument: the name of the conda environment to be created.
+# Usage example:
+# . ./create_env_and_build.sh <env-name>
+
+
+####################################
+# helper functions
+
 # set -x
 set -e
 
@@ -17,6 +25,10 @@ safe_exit() {
     exit 1
 }
 
+
+####################################
+# script logic
+
 if [ $# -ne 1 ]; then
     echo "Usage: $0 <conda-environment-name>"
     safe_exit