aboutsummaryrefslogtreecommitdiff
path: root/STYLE-GUIDE.md
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2013-01-27 19:41:28 +0100
committerTrygve Laugstøl <trygvis@inamo.no>2013-01-27 19:49:58 +0100
commit1e4a96730da70fcfa3b8c153874cbdebad0f9829 (patch)
tree9495f33f6b54621e0a684b553b64a6958744c1e3 /STYLE-GUIDE.md
parente1daac32c5b7ca0d902c16135d361aa5303f5124 (diff)
downloadapp.sh-1e4a96730da70fcfa3b8c153874cbdebad0f9829.tar.gz
app.sh-1e4a96730da70fcfa3b8c153874cbdebad0f9829.tar.bz2
app.sh-1e4a96730da70fcfa3b8c153874cbdebad0f9829.tar.xz
app.sh-1e4a96730da70fcfa3b8c153874cbdebad0f9829.zip
o Starting on a style guide.
app-conf: Adding 'import' command. app-cat-conf: Adding support for multiple -f flags. The default files can be switched off. A file named "-" is the same as /dev/stdin. app: Adding a way to enable debugging. app-install-file: Import any configuration delivered with the package.
Diffstat (limited to 'STYLE-GUIDE.md')
-rw-r--r--STYLE-GUIDE.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md
index 21f1523..1137425 100644
--- a/STYLE-GUIDE.md
+++ b/STYLE-GUIDE.md
@@ -1,9 +1,14 @@
Style Guide
-----------
-Usage
+Basic
=====
+* Indent: two spaces. Spaces >> tabs.
+
+Creating `usage()`
+==================
+
* Always echo to `stderr`.
* Exit with code 1.
* Enclose required arguments in angle brackets: `-v <version>`
@@ -14,4 +19,7 @@ Usage
exit 1
}
+Resources
+---------
+* Parameter expansion: <http://wiki.bash-hackers.org/syntax/pe>