summaryrefslogtreecommitdiff
path: root/INSTALL
blob: 9bd2010ac7fd3227bcc4c228aa8c9677ca17261b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
certainly no reason why it shouldn't work properly under Cygwin though.


----------------------------------------------------------------------------
I. BUILDING FOR MINGW & CYGWIN
----------------------------------------------------------------------------

To build:

1. 'cd src'.

2. Edit GNUmakefile and edit the following variables as required:

	INSTALLDIR	This is the directory in which the headers and
			library will be installed as $INSTALLDIR/include
			and $INSTALLDIR/lib.  The default is /usr/local, but
			if you're going to use it ouside MSYS/Cygwin set a
			DOS path, but use *forward* slashes.

	CREATECONF	If set to 1 then this creates a w32dlib-config
			shell script.  This is always installed into
			/usr/local/bin (as you have a proper shell, I
			assume your using either MSYS or Cygwin).  If not
			edit install.sh accordingly.

	DEBUG		Uncomment this line if you want a debug (-g) build
			that also sends some rudementary output to a text file.

3. Type 'make depend' and then 'make'.

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.  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.3 2005-04-15 23:56:34 ianc Exp $