summaryrefslogtreecommitdiffstats
path: root/ship/README.markdown
diff options
context:
space:
mode:
authortv <tv@nomic.retiolum>2013-11-06 18:03:50 +0100
committertv <tv@nomic.retiolum>2013-11-06 18:03:50 +0100
commitc63dde2f683c96bcf9c883c533efc58882139ffc (patch)
tree41effc6faf41988dfde317522f36f257d6742f52 /ship/README.markdown
parent1afa7f72d3eae517b3eb742228931694910a087a (diff)
ship: add Quickstart Guide
Diffstat (limited to 'ship/README.markdown')
-rw-r--r--ship/README.markdown9
1 files changed, 9 insertions, 0 deletions
diff --git a/ship/README.markdown b/ship/README.markdown
index 2882f732..8d2e8097 100644
--- a/ship/README.markdown
+++ b/ship/README.markdown
@@ -1,5 +1,14 @@
# ship - shellscript installation processor
+ This utility is used to build modular shell scripts using recursive macro
+ expansion.
+
+## Quickstart Guide
+
+ BUILD_PATH=libs ./build compile INPUTFILE OUTPUTFILE
+
+ If this doesen make science to you, then prepend `debug=true` to get all
+ the intermediate files printed to stdout.
## Make Interface