summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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