From 81110cb89f8eb2fa635fa25d66b52b49b19bf309 Mon Sep 17 00:00:00 2001
From: Rob Sykes <rob@rob-Ideapad-S205.(none)>
Date: Fri, 18 Jan 2013 08:11:57 +0000
Subject: [PATCH] document inst-check

---
 inst-check | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/inst-check b/inst-check
index 3b39a72..8cf64b7 100755
--- a/inst-check
+++ b/inst-check
@@ -5,6 +5,17 @@ set -e
 
 # Sanity-check of library installed on unix-like system
 
+# This script checks the installation of the entire library (including lsr).
+#
+# Distros using three separate packages can do the following (in order):
+#
+# * Install soxr pkg (i.e. basically, just the shared object)
+# * ./inst-check-soxr
+# * Install soxr-lsr pkg (i.e. basically, just the shared object)
+# * ./inst-check-soxr-lsr
+# * Install the -dev pkg (i.e. examples, headers, & pkg-config)
+# * ./inst-check PATH-OF-INSTALLED-EXAMPLES-DIR (e.g. /usr/share/doc/libsoxr/examples)
+
 # Where are the example source files:
 src=$1
 test x$src = x && src=/usr/local/share/doc/libsoxr/examples