summaryrefslogtreecommitdiff
path: root/haskell/haskell-ShellCheck/README
diff options
context:
space:
mode:
Diffstat (limited to 'haskell/haskell-ShellCheck/README')
-rw-r--r--haskell/haskell-ShellCheck/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/haskell/haskell-ShellCheck/README b/haskell/haskell-ShellCheck/README
new file mode 100644
index 0000000000..3fdcbf914b
--- /dev/null
+++ b/haskell/haskell-ShellCheck/README
@@ -0,0 +1,10 @@
+haskell-ShellCheck - shell script analysis tool
+
+The goals of ShellCheck are:
+
+* To point out and clarify typical beginner's syntax issues, that causes a shell
+ to give cryptic error messages.
+* To point out and clarify typical intermediate level semantic problems, that
+ causes a shell to behave strangely and counter-intuitively.
+* To point out subtle caveats, corner cases and pitfalls, that may cause an
+ advanced user's otherwise working script to fail under future circumstances.