diff --git a/modules/script/README.md b/modules/script/README.md index fe4339b..edc64e1 100644 --- a/modules/script/README.md +++ b/modules/script/README.md @@ -18,9 +18,9 @@ Look at `example.sh` for an example shell script. You can rename and copy the fi When creating a script, please make sure - ...its filename ends with `.sh`. - - This follows convention for (especially bash) shell scripts. - - `autorun.sh` only executes files that match `*.sh`. + - This follows convention for (especially bash) shell scripts. + - `autorun.sh` only executes files that match `*.sh`. - ...it starts with a [shebang]() like `#!/usr/bin/env bash`. - - This ensures the script is ran with the correct interpreter / shell. + - This ensures the script is ran with the correct interpreter / shell. - ...it contains the command `set -oue pipefail` near the start. - - This will make the image build fail if your script fails. If you do not care if your script works or not, you can omit this line. + - This will make the image build fail if your script fails. If you do not care if your script works or not, you can omit this line.