aboutsummaryrefslogtreecommitdiff
path: root/STYLE-GUIDE.md
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2013-01-27 15:00:27 +0100
committerTrygve Laugstøl <trygvis@inamo.no>2013-01-27 15:00:27 +0100
commite1daac32c5b7ca0d902c16135d361aa5303f5124 (patch)
tree3ebe514ae823d23b26c96d8d2db9c6b97e191de4 /STYLE-GUIDE.md
parent11c930f71db58201994265b71a8f76187f1dbda1 (diff)
downloadapp.sh-e1daac32c5b7ca0d902c16135d361aa5303f5124.tar.gz
app.sh-e1daac32c5b7ca0d902c16135d361aa5303f5124.tar.bz2
app.sh-e1daac32c5b7ca0d902c16135d361aa5303f5124.tar.xz
app.sh-e1daac32c5b7ca0d902c16135d361aa5303f5124.zip
o Creating an initial version of install-file.
Diffstat (limited to 'STYLE-GUIDE.md')
-rw-r--r--STYLE-GUIDE.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md
new file mode 100644
index 0000000..21f1523
--- /dev/null
+++ b/STYLE-GUIDE.md
@@ -0,0 +1,17 @@
+Style Guide
+-----------
+
+Usage
+=====
+
+* Always echo to `stderr`.
+* Exit with code 1.
+* Enclose required arguments in angle brackets: `-v <version>`
+* Enclose optional arguments in square brackets: `[-h hook]`
+
+ usage() {
+ echo "usage: $0 -v <version> [-h hook]"
+ exit 1
+ }
+
+