Small updates:
[wxWidgets.git] / docs / msw / install.txt
1
2 Installing wxWindows 2.5.0
3 --------------------------
4
5 This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT,
6 Windows 2000 and Windows XP. This is an unstable development release.
7
8 Please note that the library naming conventions for VC++
9 compilation have changed after 2.3.1. This means that
10 you will need to change your application project files. See the
11 relevant section below for details.
12
13 IMPORTANT NOTE: If you experience problems installing, please
14 re-read this instructions and other related files (changes.txt,
15 readme.txt, FAQ) carefully before mailing wx-users. Preferably,
16 try to fix the problem first and then upload a patch to
17 SourceForge:
18
19   http://sourceforge.net/patch/?group_id=9863
20
21 Please report bugs using the SourceForge bug tracker:
22
23   http://sourceforge.net/bugs/?group_id=9863
24
25 Unarchiving
26 -----------
27
28 A setup program is provided (setup.exe) to automatically copy
29 files to a directory on your hard disk. Do not install into a
30 path that contains spaces. To avoid confusion with other
31 wxWindows installations that might be on your machine, the
32 installation program does not se the WXWIN environment variable;
33 please set this by hand via the System applet if you wish to
34 make it permanent.
35
36 The setup program contains the following:
37
38 - All common, generic and MSW-specific wxWindows source;
39 - samples;
40 - documentation in Windows Help format;
41 - makefiles for most Windows compilers, plus CodeWarrior,
42   BC++ and VC++ IDE files;
43 - JPEG library source;
44 - TIFF library source;
45 - Object Graphics Library;
46 - Tex2RTF source;
47 - Dialog Editor binary.
48
49 Alternatively, you may unarchive the .zip form by hand:
50 wxMSW-x.y.z.zip where x.y.z is the version number.
51
52 Unarchive the required files plus any optional documentation
53 files into a suitable directory such as c:\wx.
54
55 Other add-on packages are available from the wxWindows Web site, such as:
56
57 - mmedia.zip. Audio, CD, video access for Windows and Linux.
58 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
59 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
60   the same document source.
61
62 General installation notes
63 --------------------------
64
65 Alter your WXWIN environment variable to point to the root directory of the
66 wxWindows installation. For Cygwin or MinGW compilation, make sure WXWIN
67 contains only forward slashes.
68
69 If installing from the CVS server, copy include/wx/msw/setup0.h to
70 include/wx/msw/setup.h and edit the resulting file to choose
71 the features you would like to compile wxWindows with[out].
72
73 Compilation
74 -----------
75
76 The following sections explain how to compile wxWindows with each supported
77 compiler.
78
79 Visual C++ compilation
80 ---------------------------
81
82 Please note that the VC++ 6.0 project files will work for VC++ .NET also, but
83 you must open the .dsp files and not the .dsw files and in this case you will
84 need to manually build the other .dsp on which wxWindows.dsp depends: jpeg,
85 png, regex, tiff and zlib.
86
87 Also note that you can make the project files work with VC++ 5.0 but you'll
88 need to edit .dsp file by hand before this is possible (change the version in
89 the .dsp file header from 6.0 to 5.0).
90
91 Using project files (VC++ 6 and later):
92
93 1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
94    makefiles (already included in wxMSW-x.y.z.zip and the setup version).
95 2. Open src/wxWindows.dsw, which has configurations for static
96    compilation or DLL compilation, and each of these available in
97    Unicode/ANSI and Debug/Release variations. Normally you'll use
98    a static linking ANSI configuration. Choose the Win32 Debug or
99    Win32 Release configuration for the wxWindows project, and compile.
100    Alternatively, use Batch Build to build more than one
101    configuration.
102    The following libraries will be produced depending on chosen
103    configuration:
104
105    wxmsw.lib     wxmswd.lib      ; ANSI Release/Debug
106    wxmswu.lib    wxmswud.lib     ; UNICODE Release/Debug
107    wxmsw23x.lib  wxmsw23xd.lib   ; ANSI DLL Release/Debug
108    wxmsw23xu.lib wxmsw23xud.lib  ; UNICODE DLL Release/Debug
109
110    It will also produce similar variations on jpeg.lib, png.lib,
111    tiff.lib, zlib.lib, and regex.lib.
112 3. Open a sample project file, choose a configuration such as
113    Win32 Debug using Build | Set Active Configuration..., and compile.
114    The project files don't use precompiled headers, to save disk
115    space, but you can switch PCH compiling on for greater speed.
116    NOTE: you may also use samples/samples.dsw to access all
117    sample projects without opening each workspace individually.
118    You can use the Batch Build facility to make several samples
119    at a time.
120
121 Using makefiles:
122
123 1. Make sure your WXWIN variable is set.
124 2. If you do NOT have the TIFF or JPEG source code, please remove
125    the tiff and jpeg targets from the 'all' target in
126    src\msw\makefile.vc. Also ensure the settings in
127    include\wx\msw\setup.h specify not to use JPEG or TIFF.
128 3. Change directory to wx\src\msw. Type:
129
130   'nmake -f makefile.vc'
131
132    to make the wxWindows core library with debug information
133    (wx\lib\wxd.lib), then
134
135   'nmake -f makefile.vc cleanall FINAL=1'
136   'nmake -f makefile.vc FINAL=1'
137
138    to make the wxWindows core library without debug information.
139 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
140    to make all the samples. You can also make them individually.
141
142 Makefile notes:
143
144   Use the 'cleanall' target to clean all objects, libraries and
145   executables.
146
147   To build the release version using makefiles, add FINAL=1 to your
148   nmake invocation, both when building the library and for samples.
149   You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
150   before making a different configuration, because otherwise
151   object files used to build the previous configuration may be
152   used accidentally for the current configuration. You might see
153   this manifested in unexpected link errors or warnings. This problem
154   doesn't occur when using project files to build wxWindows.
155
156   To build Unicode versions of the libraries, add UNICODE=1
157   to the nmake invocation (default is UNICODE=0). If you want to
158   be able to use Unicode version on Windows9x, you will need 
159   MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
160   The former can be downloaded from Microsoft, the latter is part
161   of the latest Platform SDK from Microsoft (see msdn.microsoft.com 
162   for details). An alternative implementation of import library can
163   be downloaded from http://libunicows.sourceforge.net - unlike the
164   official one, this one works with other compilers and does not
165   require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
166   invocation to enable MSLU.
167
168   Note that the wxWindows core library allows you to have debug
169   and release libraries available simultaneously, by compiling the
170   objects in different subdirectories, whereas samples must be
171   cleaned and re-made to build a different configuration.
172
173 To build the DLL version using makefiles:
174
175 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll'
176    to make both a suitable DLL and import library, and to build a
177    suitable precompiled header file for compiling applications.
178    See the previous section for library names.
179 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
180    (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
181    applications).
182
183 Note (1): if you wish to use templates, please edit
184 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
185 Without this, the redefinition of 'new' will cause problems in
186 the headers. Alternatively, #undef new before including template headers.
187 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
188 using templates, to avoid the non-template stream files being included
189 within wxWindows.
190
191 Note (2): libraries and applications generated with makefiles and
192 project files are now (hopefully) compatible where static libraries
193 are concerned, but please exercise caution nevertheless and if
194 possible, use one method or the other.
195
196 Note (3): VC++ 5's optimization code seems to be broken and can
197 cause both compile and run-time problems: this can be seen when
198 deleting an object Dialog Editor, in Release mode with optimizations
199 on. If in doubt, switch off optimisations, although this will result in much
200 larger executables. It seems possible that the library can be created with
201 strong optimization, so long as the application is not strongly
202 optimized. For example, in wxWindows project, set to 'Minimum
203 Size'. In Dialog Editor project, set to 'Customize: Favor Small
204 Code' (and no others). This will then work.
205
206 Note (4): some crash problems can be due to inconsistent compiler
207 options. If strange/weird/impossible things start to happen please
208 check (dumping IDE project file as makefile and doing text comparison
209 if necessary) that the project settings, especially the list of defined
210 symbols, struct packing, etc. are exactly the same for all items in
211 the project. After this, delete everything (including PCH) and recompile.
212
213 Note (5): to create your own IDE files, see the technical note on the
214 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
215 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
216 wxWindows distribution). You can also copy .dsp and .dsw
217 files from an existing wxWindows sample and adapt them.
218
219 Visual C++ 1.5 compilation (16-bit)
220 -----------------------------------
221
222 NOTE: this has not been tested recently and probably doesn't
223 work.
224
225 1. Make sure your WXWIN variable is set, and uses the FAT (short
226    name) form.
227 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
228    make the wxWindows core library.
229 3. Change directory to a sample, such as wx\samples\minimal, and
230    type 'nmake -f makefile.dos'.
231
232 Add FINAL=1 to your makefile invocation to build the release
233 versions of the library and samples.
234
235 Use the 'clean' target to clean all objects, libraries and
236 executables.
237
238 Borland C++ 4.5/5.0/5.5 compilation
239 -------------------------------
240
241 Compiling using the makefiles (updated 24 Sept 02):
242
243 1. Make sure your WXWIN variable is set [e.g add
244    set WXWIN=c:\wxwindows
245    to your autoexec.bat file], The WXWIN variable should contain neither spaces nor -
246    You may like to use the short form as shown by a dos directory listing ; 
247    eg instead of c:\wxwindows-2.5.0 use c:\wxwind~1.4
248    Reboot if needed for the changes to autoexec.bat to take effect.   
249 2. Change directory to src\msw. Type 'make -f makefile.b32' to
250    make the wxWindows core library. Ignore the compiler warnings.
251    This produces a library in the wxwindows\lib directory called
252    wx32ds.lib
253 3. Change directory to a sample or demo such as samples\minimal, and type
254   'make -f makefile.b32'. This produces a windows exe file
255 4. For release versions, recompile wxWindows and samples using
256    'make -f makefile.b32 clean'
257    'make -f makefile.b32 FINAL=1'
258    for the library and samples. This produces a library wx32s.lib eliminating
259    all debugging information - if you wish to retain reduced debugging information
260    'make -f makefile.b32 clean'
261    'make -f makefile.b32 FINAL=hybrid'
262
263 5. To make and use wxWindows as a DLL, type
264    'make -f makefile.b32 clean'
265    'make -f makefile.b32 DLL=1'
266    which generates a DLL (wx32d.dll) and import library (wx32d.lib), 
267    and then for each sample,
268    'make -f makefile.b32 WXUSINGDLL=1'
269    Please note that the samples have not been exhaustively tested
270    with this configuration. You may also generate a sepratae library
271    and second DLL using the commands
272    'make -f makefile.b32 clean'
273    'make -f makefile.b32 DLL=1 FINAL=1'
274    which generates a DLL (wx32.dll) and import library (wx32.lib), 
275    and then for each sample,
276    'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
277
278 6. You can use the WXUNIVERSAL widgets instead of the native MSW
279    ones (eg if you want to build an application with the same
280    look and feel on all platforms)
281    Use the command
282    'make -f makefile.b32 WXUSINGUNIV=1'
283    Then run
284    'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory  which you wish
285    to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or  WIN32 or METAL]
286    to test the existing themes
287    The makefile is written with the intention that you can build DLLs
288    and  do final releases by combinations of commandline parameters.
289    At the time of writing, (Oct 02) not all the wxDialogs are working
290
291 7. To make console mode applications with wxWindows functions go
292    to the src\msw directory
293    'make -f makebase.b32 clean'
294    'make -f makebase.b32'
295    There is a sample\console directory and in this type
296    'make -f makefile.b32 wxUSE_GUI=0'
297
298 Note (0): This provides the ability to produce separate wxwindows libraries
299    for different purposes, and only have to rebuild the applications
300
301
302 Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
303 in the autoexec.bat file; like this:
304    set BCCDIR=c:\progra~1\borland\bcc
305    so that it points to the root directory of 
306    your Borland C++ installation, and it uses the FAT (short
307    name) form with no spaces.
308
309
310 Note (2): the wxWindows library and (some) samples compile in 16-bit mode
311 using makefile.bcc, but at present the wxWindows resource system is switched
312 off in this mode. See issues.txt for details.
313
314 Note (3): unfortunately most samples won't link in 16-bit mode,
315 because the automatic data segment exceeds 64K. The minimal
316 sample links and runs, however.
317
318 Note (4): the wxWindows makefiles assume byte structure alignment. Please
319 make sure that your own project or makefile settings use the
320 same alignment, or you could experience mysterious crashes. To
321 change the alignment, add a suitable option to the $(CFG) target code
322 in src/msw/makefile.b32.
323
324 Note (5): if you get undefined _SQL... symbols at link time,
325 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
326 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
327 recompile wxWindows. The same applies if compiling using the IDE.
328
329 Note (6): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
330 you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
331 the jpeg target from src\msw\makefile.b32, and remove jpeg from
332 src\makeprog.b32.
333
334
335 Note (7): If you wish debug messages to be sent to the console in
336 debug mode, edit src\makeb32.env and change /aa to /Tpe in
337 LINK_FLAGS.
338
339 Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
340
341 1. Load src\bc32.ide (Release settings)
342 2. Go to Options|Project... and specify the correct BC++ include and lib path for
343    your file structure.
344 3. Press F9 to compile the wxWindows library.
345 4. Load samples\bc32.ide.
346 5. Go to Options|Project... and specify the correct BC++ include and lib path for
347    your file structure.
348 6. Press F9 to compile the samples (build each node separately if
349    you prefer, by right clicking and choose Build Node).
350 7. Run each sample: you may need to run from each sample's directory
351    since some (notably the wxHTML samples) look for files
352    relative to the working directory.
353
354 Note (1): the samples project file contains a selection of
355 samples, and not all samples. The remaining samples can be made
356 with the makefiles. See also the demos hierarchy which doesn't
357 have any BC++ project files yet.
358
359 Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
360 some samples) you need to compile them with bc32.ide.
361
362 Note (3): the debug version of the wxWindows library is about 40 MB, and the
363 release version is around 5 MB.
364
365 See also the file docs/tech/tn0007.txt for further instructions and details
366 of how to create your own project files.
367
368 ** REMEMBER **
369
370 In all of your wxWindows applications, your source code should include 
371 the following preprocessor directive:
372
373 #ifdef __BORLANDC__
374 #pragma hdrstop
375 #endif
376
377 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for 
378 more details) 
379
380 Borland C++Builder IDE compilation
381 ------------------------------
382
383 1. Build the wxWindows libraries using the Borland make utility as
384    specified in the section called "Borland C++ 4.5/5.0 compilation"
385    above. (C++ Builder includes a stand-alone C++ compiler.  For example,
386    C++ Builder 4.0 comes with C++ 5.4.)
387
388 2. You can build samples using the makefiles as per the
389    instructions for BC++ above, or you can follow the instructions
390    in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
391    You can use the process_sample_bcb.bat command which is in
392    wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
393    samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
394    directory, passing the name of the cpp files on the command line.
395
396 Watcom C++ 10.6/11 compilation
397 ---------------------------
398
399 1. Make sure your WXWIN variable is set, and uses the DOS short
400    name form.
401 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to
402    make the wxWindows core library.
403 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'
404    to make this sample. Repeat for other samples of interest.
405
406 Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
407 directory. See the notes in that directory.
408 Note (2): if variant.cpp is compiled with date/time class
409 options, the linker gives up. So the date/time option is switched
410 off for Watcom C++. Also, wxAutomationObject is not compiled with
411 Watcom C++.
412 Note (3): if Watcom can't read the precompiled header when
413 building a sample, try deleting src\msw\watcom.pch and
414 compiling the sample again.
415
416 Metrowerks CodeWarrior compilation
417 ----------------------------------
418
419 1. CodeWarrior Pro7 project files in XML format are already 
420    included in wxMSW-2.5.0.zip and the setup version.
421 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if 
422    you are working from the CVS version) to make sure the settings reflect 
423    what you want.  If you aren't sure, leave it alone and go with the 
424    default settings.  A few notes:
425        - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
426        - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports 
427          will be rather confusing due to interactions with the MSL ANSI
428          and runtime libs.
429 3. The project file to build the Win32 wxWindows libraries relies on the 
430    Batch File Runner plug-in.  This plug-in is not installed as part of 
431    a normal CW7 installation.  However, you can find this plug-in on the 
432    CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the 
433    "Batch File Post Linker". 
434 4. If you choose not to install the Batch File Runner plug-in, then you 
435    need to do the following by hand:
436       (1) Create the directories lib\cw7msw\include\wx and copy the file 
437           include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are 
438           working from the CVS version) to lib\cw7msw\include\wx\setup.h
439       (2) Create the directories lib\cw7mswd\include\wx and copy the file 
440           include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are 
441           working from the CVS version) to lib\cw7mswd\include\wx\setup.h
442 5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
443    Store this project file in directory src.  You may get warnings about 
444    not being able to find certain project paths; ignore these warnings, the 
445    appropriate paths will be created during the build by the Batch File Runner.
446 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You 
447    will get some warnings about hidden virtual functions, illegal conversions 
448    from const pointers to pointers, etc., all of which you can safely ignore.
449    ***Note:  if you get errors that the compiler can't find "wx/setup.h", just 
450    stop the build and build again.  These errors occur because sometimes the 
451    compiler starts doing its thing before the copying of setup.h has completed.
452 7. The following libraries will be produced depending on chosen
453    target:
454        - wx_x86.lib             ANSI Release (static)
455        - wx_x86_d.lib           ANSI Debug (static)
456 8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
457    Volunteers for this are welcome (as neither DLLs nor unicode builds are 
458    big priorities for me ;).
459 9. CodeWarrior Pro7 project files (in XML format) are also provided for some 
460    of the samples.  In particular, there are project files for the minimal, 
461    controls, dialogs, dnd, nd docview samples.  You can use these project 
462    files as templates for the other samples and for your own projects.  
463        - For example, to make a project file for the "newgrid" sample, 
464          just copy the project file for the "minimal" sample, minimalW7.mcp 
465          (made by importing minimalW7.xml into CodeWarrior), into the 
466          sample/newgrid directory, calling it newgridW7.mcp.  Open 
467          newgridW7.mcp and revise the project by deleting the files 
468          minimal.rc and minimal.cpp and adding the files griddemo.rc and 
469          griddemo.cpp.  Build and run....
470
471 Cygwin/MinGW compilation
472 ----------------------------------
473
474 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
475 releases, and MinGW. Cygwin can be downloaded from:
476
477     http://sources.redhat.com/cygwin/
478
479 and MinGW from:
480
481     http://www.mingw.org/
482
483 Both Cygwin and MinGW can be used with the same makefiles, and both can be
484 used with configure.
485
486 NOTE: some notes specific to old Cygwin (< 1.1.x)
487       and MinGW (< 1.0) are at the end of this section
488       (see OLD VERSIONS)
489
490 There are two methods of compiling wxWindows, by using the
491 makefiles provided or by using 'configure'.
492
493 Retrieve and install the latest version of Cygwin, or MinGW, as per
494 the instructions with either of these packages.
495
496 If using MinGW, you can download the add-on MSYS package to
497 provide Unix-like tools that you'll need to build wxWindows.
498 If you do not want to use MSYS, then you need to download extra utilities from
499 ports/mingw32 on the wxWindows ftp site or CD-ROM:
500
501   ftp://biolpc22.york.ac.uk/pub/ports/mingw32/extra.zip
502   
503 These should be extracted to a directory in your path. If you have 
504 already downloaded rm, cp, mv from elsewhere, or are using
505 MSYS, you won't need all of these files. However if using MSYS
506 and configure to build wxWindows, you will need to unzip the
507 following files from extra.zip and place them in e.g. an
508 extrabin directory which you then add to your path:
509
510   bison.exe bison.hairy bison.simple flex.exe
511
512 You will also need to set these variables:
513
514   set BISON_SIMPLE=c:\apps\mingw2.0.0-3\extrabin\bison.simple
515   set BISON_HAIRY=c:\apps\mingw2.0.0-3\extrabin\bison.hairy
516
517 Here we're setting them in DOS before invoking 'sh', but you
518 could set them within the shell instead.
519
520 The 'configure' method uses flex and bison, whereas the
521 direct makefile method uses pregenerated C files.
522
523 Using makefiles directly
524 ========================
525
526 NOTE: The makefile are for compilation under Cygwin, MSYS, or
527       command.com/cmd.exe, they won't work in other environments
528       (such as UNIX)
529
530 Here are the steps required using the provided makefiles:
531
532 - Set your WXWIN variable to where wxWindows is installed.
533   *** IMPORTANT: For Cygwin/MinGW, use forward slashes in the path, not
534   backslashes.
535
536 - Edit src/makeg95.env and set the MINGW32 variable at the top of
537   the file to either 1 (you have MinGW) or 0 (if you have
538   Cygwin); also set the MINGW32VERSION variable appropriately for your
539   GCC version.
540
541 - Use the makefile.g95 files for compiling wxWindows and samples,
542   e.g. to compile a debugging version of wxWindows:
543   > cd c:\wx\src\msw
544   > make -f makefile.g95 clean
545   > make -f makefile.g95
546   > cd c:\wx\samples\minimal
547   > make -f makefile.g95 cleanall
548   > make -f makefile.g95
549
550   to compile with optimizations:
551   > cd c:\wx\src\msw
552   > make -f makefile.g95 clean
553   > make -f makefile.g95 FINAL=1
554   > cd c:\wx\samples\minimal
555   > make -f makefile.g95 cleanall
556   > make -f makefile.g95 FINAL=1
557
558   to compile a DLL:
559   > cd c:\wx\src\msw
560   > make -f makefile.g95 clean
561   > make -f makefile.g95 WXMAKINGDLL=1
562   > cd c:\wx\samples\minimal
563   > make -f makefile.g95 cleanall
564   > make -f makefile.g95 WXUSINGDLL=1
565
566   to compile the Unicode version:
567   > cd c:\wx\src\msw
568   > make -f makefile.g95 clean
569   > make -f makefile.g95 UNICODE=1
570   > cd c:\wx\samples\minimal
571   > make -f makefile.g95 cleanall
572   > make -f makefile.g95 UNICODE=1
573
574   Options can be combined (e.g.: UNICODE=1 FINAL=1)
575
576   Ignore the warning about the default entry point.
577
578 - Use the 'strip' command to reduce executable/dll size (note that
579   stripping an executable/dll will remove debug information!).
580
581 - With Cygwin, you can invoke gdb --nw myfile.exe to
582   debug an executable. If there are memory leaks, they will be
583   flagged when the program quits. You can use Cygwin gdb
584   to debug MinGW executables.
585
586 All targets have 'clean' targets to allow removal of object files
587 and other intermediate compiler files and 'cleanall' targets to
588 allow removal of all object files and library files.
589
590 Using configure
591 ===============
592
593 Instead of using the makefiles, you can use the configure
594 system to generate appropriate makefiles, as used on Unix
595 and Mac OS X systems.
596
597 Change directory to the root of the wxWindows distribution,
598 make a build directory, and run configure and make in this directory.
599
600 For example:
601
602   cd $WXWIN
603   mkdir build-debug
604   cd build-debug
605   ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
606   make
607   cd samples/minimal
608   make
609   ./minimal.exe
610
611 Notes:
612
613 1. See also the Cygwin/MinGW on the web site or CD-ROM for
614    further information about using wxWindows with these compilers.
615
616 2. libwx.a is 100 MB or more - but much less if compiled with no
617    debug info (-g0) and level 4 optimization (-O4).
618
619 3. If you get a link error under MinGW 2.95.2 referring to:
620
621    EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
622
623    then you need to edit the file objidl.h at line 663 and add
624    a missing PURE keyword:
625
626    STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
627
628 4. There's a bug in MinGW headers for some early distributions.
629
630    in include/windows32/defines.h, where it says:
631
632    #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
633
634    it should say:
635
636    #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
637
638    (a missing bracket).
639
640 5. If there's a problem with the copy or remove commands in
641    src/msw/makefile.g95, you may need to change the COPY and
642    RM variables in makeg95.env.
643
644 6. If there's a problem executing the windres program, try
645    commenting out RCPREPROCESSOR in makeg95.env.
646
647 7. OpenGL support should work with MinGW as-is. However,
648    if you wish to generate import libraries appropriate either for
649    the MS OpenGL libraries or the SGI OpenGL libraries, go to
650    include/wx/msw/gl and use:
651
652      dlltool -k -d opengl.def -llibopengl.a
653
654    for the SGI DLLs, or
655
656      dlltool -k -d opengl32.def -llibopengl32.a
657
658    and similarly for glu[32].def.
659
660 OLD VERSIONS:
661
662 - If using MinGW 2.95 and below with wxWindows 2.1 or above, you
663   must hand-patch with Mingw32-gcc295.patches (located in the
664   top-level of the wxWindows 2 installation). MinGW 2.95.2
665   and above contain the fixes already.
666
667 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
668   to set up appropriate variables, if necessary mounting drives.
669   Run it before compiling.
670
671 - For Cygwin, make sure there's a \tmp directory on your
672   Windows drive or bison will crash (actually you don't need
673   bison for ordinary wxWindows compilation: a pre-generated .c file is
674   supplied).
675
676 - If using GnuWin32 b18, you will need to copy windres.exe
677   from e.g. the MinGW distribution, to a directory in your path.
678
679 Symantec C++ compilation
680 ------------------------
681
682 1. Make sure your WXWIN variable is set, and uses the FAT (short
683    name) form.
684 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
685 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
686    make the wxWindows core library.
687 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
688    to make this sample.
689
690 Note: the minimal sample doesn't link properly ('Error: no
691 start address').
692 32-bit compilation only (partially) supported at present, using SC++ 6.1.
693 Some functionality is missing using this compiler (see makefile).
694 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
695 Step (2). 16-bit compilation is left as an exercise for the user!
696
697 Salford C++ compilation
698 -----------------------
699
700 1. Make sure your WXWIN variable is set, and uses the FAT (short
701    name) form.
702 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
703    notes.
704 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
705    make the wxWindows core library.
706 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
707    to make this sample.
708
709 Unfortunately, Salford C++ seems to have problems with its code generation for
710 operations on objects, as seen in wxFrame::OnMenuHighlight
711 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
712 the debugging version of the library is 90MB, with samples coming in
713 at 40MB :-) However, wxWindows at least makes a good test suite for
714 improving the compiler.
715
716 TWIN32 and gcc on Linux
717 -----------------------
718
719 The wxWindows 2 for Windows port may be compiled using
720 the TWIN32 emulator package from www.willows.com. However,
721 TWIN32 is by no means finished so this should be taken as
722 something to think about for the future, rather than
723 a tool for writing products with.
724
725 Use makefile.twn in much the same way as makefile.g95, as
726 described above. Not all sample makefiles are supplied yet.
727
728 For some reason, I found I had to copy TWIN32's Windows resource
729 compiler (rc) to the current working directory for it to be found.
730
731 General Notes
732 -------------
733
734 - Debugging: under Windows 95, debugging output isn't output in
735   the same way that it is under NT or Windows 3.1.
736   Please see DebugView (bin/dbgview.exe in the distribution), also
737   available from http://www.sysinternals.com and on the wxWindows CD-ROM
738   under Packages.
739
740 - If you are installing wxWindows 2 from CVS, you may find that
741   include/wx/msw/setup.h is missing. This is deliberate, to avoid
742   developers' different setup.h configurations getting confused.
743   Please copy setup0.h to setup.h before compiling. Also, read
744   the BuildCVS.txt for other hints.
745