From 339682700982983738dd6cdffc387393bb2bd5bb Mon Sep 17 00:00:00 2001
From: Ian C <ianc@noddybox.co.uk>
Date: Fri, 15 Apr 2005 23:56:34 +0000
Subject: Few doc changes and changed --libs not to return -mwindows

---
 INSTALL | 56 ++++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 48 insertions(+), 8 deletions(-)

(limited to 'INSTALL')

diff --git a/INSTALL b/INSTALL
index 849c57e..9bd2010 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,9 +1,14 @@
 This library is geared towards being compiled with MINGW, using MSYS and GNU
 Make.
 
-It builds OK, but has only been basically tested under Cygwin.  There is
+It builds OK, but has only been basically tested, under Cygwin.  There is
 certainly no reason why it shouldn't work properly under Cygwin though.
 
+
+----------------------------------------------------------------------------
+I. BUILDING FOR MINGW & CYGWIN
+----------------------------------------------------------------------------
+
 To build:
 
 1. 'cd src'.
@@ -23,22 +28,57 @@ To build:
 			edit install.sh accordingly.
 
 	DEBUG		Uncomment this line if you want a debug (-g) build
-			that also sends some rudementary output to the
-			Windows API OutputDebugString().
+			that also sends some rudementary output to a text file.
 
-3. Type 'make'.
+3. Type 'make depend' and then 'make'.
 
-4. If OK, 'cd test' and 'make' again.  Run w32dtest.exe and make sure it
-   looks like it's not going to fall over in a heap.
+4. If OK, 'cd test' and 'make depend' and make' again.  Run w32dtest.exe and
+   make sure it looks like it's not going to fall over in a heap.
 
 5. If all OK, 'cd ..' and 'make install'.
 
 6. For documentation, 'cd src' and then 'make doc'.  The documentation
    will be in ./doc/html -- use index.html to start.  Copy these whereever
-   you want.
+   you want.  Note that doxygen must be on the path for this to work.
 
 7. Alternatively look at ./src/test/w32dtest.cpp for example code on using
    w32dlib.
 
+
+----------------------------------------------------------------------------
+II. W32DLIB-CONFIG USAGE
+----------------------------------------------------------------------------
+
+If you set up the makefile to install w32dlib-config you can use it in
+makefiles to aid portability between user's development environments.
+
+usage: w32dlib-config [--libs|--cflags|-archive]
+
+--libs		Provides the necessary -L and -l arguments to use W32DLib.
+		Note that -mwindows will also be seperately needed.
+
+		eg.
+
+		% w32dlib-config --libs
+		-L/usr/local/lib -lw32dlib -lcomctl32 -lcomdlg32 -lole32
+
+--cflags	Provides the necessary compiler switches to see the include
+		files.
+
+		eg.
+
+		% w32dlib-config --cflags
+		-I/usr/local/include
+
+--archive	In case you have a need (I thought I did, but it turned out
+		I didn't, but the switch stays) to reference the library archive
+		directly, it's name can be got with this.
+
+		eg.
+
+		% w32dlib-config --archive
+		/usr/local/lib/libw32dlib.a
+
+
 ----------------------------------------------------------------------
-$Id: INSTALL,v 1.2 2005-04-05 01:01:58 ianc Exp $
+$Id: INSTALL,v 1.3 2005-04-15 23:56:34 ianc Exp $
-- 
cgit v1.2.3