Tell Windows users to build with '--disable-shared'

As detailed in GitHub issue #1, attempting to build ppamltracer as a
shared library on Cygwin fails.  I believed commit bfc92ba (‘autotools:
Don’t build DLLs on Cygwin by default’) fixed this; it does, but it also
disables shared library building on non-Cygwin systems.

We need to do a release, so this bug is getting deferred until later;
for the time being, the documented workaround is to pass
'--disable-shared' to 'configure'.

1 files changed, 14 insertions, 1 deletions

diff --git a/INSTALL b/INSTALL
index cc29059..0f9d653 100644
--- a/INSTALL
+++ b/INSTALL
@@ -53,7 +53,9 @@ The simplest way to compile this package is:
      <http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/otf>.
 
   2. `cd' to the directory containing the package's source code and type
-     `./configure' to configure the package for your system.
+     `./configure' to configure the package for your system.  If you're
+     building for Cygwin, you should pass `--disable-shared' to `configure';
+     ppamltracer will not build as a shared library for Cygwin.
 
      Running `configure' might take a while.  While running, it prints some
      messages telling which features it is checking for.
@@ -79,6 +81,17 @@ The simplest way to compile this package is:
      test that all other targets like `make install' and `make uninstall' work
      correctly.  This target is generally not run by end users.
 
+Platform Specific Compilation Notes
+===================================
+
+As mentioned above, ppamltracer will not build as a shared library for Cygwin.
+To build ppamltracer for Cygwin, you'll need to run `configure' with the
+`--disable-shared' option:
+
+     ./configure --disable-shared
+
+This is a known issue.
+
 Compilers and Options
 =====================