Add Suil-specific instructions to PACKAGINE.

git-svn-id: http://svn.drobilla.net/lad/trunk/suil@3322 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 21 insertions, 1 deletions

diff --git a/PACKAGING b/PACKAGING
index 3eced16..735a1c6 100644
--- a/PACKAGING
+++ b/PACKAGING
@@ -1,3 +1,6 @@
+These are generic guidelines, but please see below for important Suil specific
+information.
+
 This library is designed to allow parallel installation of different major
 versions.  To facilitate this, the shared library name, include directory, and
 pkg-config file are suffixed with the major version number of the library.
@@ -26,4 +29,21 @@ upstream source package.
 
 Because program and documentation names are not versioned, these should be
 included in separate packages which may replace previous versions, since
-there is little use in having parallel installations of them.
\ No newline at end of file
+there is little use in having parallel installations of them.
+
+*** IMPORTANT GUIDELINES FOR PACKAGING SUIL ***
+
+The purpose of Suil is to abstract plugin UI toolkits away from host code.  To
+achieve this, Suil performs its magic by dynamically loading modules for each
+toolkit.  The main Suil library does NOT depend on any toolkit libraries, and
+thus neither should your package.  Please package the individual modules
+(e.g. libsuil_gtk2_in_qt4.so) as separate packages, which themselves depend on
+the involved toolkits.  These packages should also be versioned as described
+above to support parallel installation.
+
+Please do not make the main Suil package depend on any toolkit package, this
+defeats the purpose of Suil and will severely irritate those who for whatever
+reason do not want a particular toolkit dependency.  The main Suil package may
+have a weak dependency (e.g. "recommends") on the individual wrapper modules,
+and it's fine if these are installed by default, but it must be possible to
+install Suil without installing them if the user explicitly wishes to do so.