Skip to content

Commit df65bcc

Browse files
author
Wes Dean
committed
Update readme
1 parent 2010a64 commit df65bcc

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,16 @@
1-
# bash_shell_script_starter
1+
# 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

Comments
 (0)