From c63dde2f683c96bcf9c883c533efc58882139ffc Mon Sep 17 00:00:00 2001
From: tv <tv@nomic.retiolum>
Date: Wed, 6 Nov 2013 18:03:50 +0100
Subject: ship: add Quickstart Guide

---
 ship/README.markdown | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'ship')

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
 
-- 
cgit v1.2.3