We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 2010a64 commit df65bccCopy full SHA for df65bcc
README.md
@@ -1 +1,16 @@
1
-# bash_shell_script_starter
+# bash\_shell\_script\_starter
2
+
3
+This is a starter / template for writing Bash scripts. It includes a
4
+few things:
5
6
+1. some Doxygen-style comments to start things off
7
+2. flags to protect us from undefined variables and failed commands
8
+3. a `SCRIPT_PATH` variable so we can reference where the script lives
9
+4. an error trap that prints the line where an error happens
10
+5. a stack dump when errors do happen
11
+6. a wrapper to allow us to source this script as if it was a library
12
+7. CLI parameter handling
13
+8. automagic help / usage generation
14
15
+The goal is to help write scripts that are safer, cleaner, more usable,
16
+more testable, and easier to debug.
0 commit comments