oops, compilation error - fixed
[wxWidgets.git] / docs / msw / install.txt
index 2e68fcd76ad4f678a01068d0077a2c35ae9f9171..608bd1276a3628467f71afb78967e00dbdf49238 100644 (file)
@@ -4,8 +4,8 @@ Installing wxWindows 2.1
 
 This is a beta release of wxWindows 2.1 for Microsoft
 Windows 95, 98 and NT. This is not a production release,
-although a huge number of bugs found in wxWindows 2.0 have been
-fixed.
+although a huge number of bugs found in earlier versions
+of wxWindows have been fixed.
 
 IMPORTANT NOTE: If you experience problems installing, please
 re-read this instructions and other related files (release.txt,
@@ -29,9 +29,8 @@ program contains the following:
 - makefiles for most Windows compilers, plus BC++ and
   VC++ IDE files;
 - JPEG library source;
+- TIFF library source;
 - Object Graphics Library;
-- wxGLCanvas library;
-- wxTreeLayout library;
 - Tex2RTF source;
 - Dialog Editor binary.
 
@@ -55,7 +54,7 @@ files into a suitable directory such as c:\wx.
 
 Other add-on packages are available from the wxWindows Web site, such as:
 
-- glcanvas.zip. Use OpenGL in a wxWindows window.
+- mmedia.zip. Audio, CD, video access for Windows and Linux.
 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
   the same document source.
@@ -80,23 +79,26 @@ compiler.
 Visual C++ 4.0/5.0/6.0 compilation
 ----------------------------------
 
-Using project files:
+Using project files (VC++ 5 and 6 only):
 
 1. Unarchive wx2_x_y_vc.zip, the VC++ 5/6 project makefiles.
-2. Open src/wxvc.dsp, set Debug or Release configuration, and
-   compile. This will produce src/Debug/wxvc.lib or
-   src/Release/wxvc.lib.  The project file src/wxvc_dll.dsp
-   will make a DLL version of wxWindow, which will go in
-   src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
-3. If you want to use JPEG in your application (such as the image
-   sample), open src/jpeg/jpeg.dsp (VC++ 5/6 only) and compile in
-   Debug and Release configurations. If you have VC++ 4,
-   use makefile.vc, but you may only have one set of object
-   files at a time in use (debug or release versions).
-4. Open a sample project file, choose a configuration using
-   Build | Set Active Configuration..., and compile.
-   The project files don't use precompiled headers, to save
+2. Open src/wxvc.dsp, set Debug or Release configuration for
+   the wxvc project, and compile. Alternatively, use Batch Build
+   to build both Debug and Release configurations.
+   This will produce lib/wx.lib (release) and lib/wxd.lib (debug),
+   plus various subordinate libraries. It assumes you have
+   the TIFF and JPEG source, which is already in the setup
+   version of the distribution.
+   The project file src/wxvc_dll.dsp will make a DLL version of wxWindow,
+   which will go in lib/wxdll.[lib,dll] and lib/wxdlld.[lib,dll].
+3. Open a sample project file, choose a configuration such as
+   Debug using Build | Set Active Configuration..., and compile.
+   The project files don't use precompiled headers, to save disk
    space, but you can switch PCH compiling on for greater speed.
+   NOTE: you may also use samples/SamplesVC.dsw to access all
+   sample projects without opening each workspace individually.
+   You can use the Batch Build facility to make several samples
+   at a time.
 
 Using makefiles:
 
@@ -119,7 +121,7 @@ Using makefiles:
 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
    to make all the samples. You can also make them individually.
 
-Notes:
+Makefile notes:
 
   Use the 'clean' target to clean all objects, libraries and
   executables.
@@ -140,8 +142,8 @@ To build the DLL version using makefiles:
    suitable precompiled header file for compiling applications.
    The resulting libraries are called:
 
-      wx\lib\wx200.lib(dll) (debug version)
-      wx\lib\wx200.lib(dll)   (release version, using FINAL=1)
+      wx\lib\wx[version].lib(dll) (debug version)
+      wx\lib\wx[version].lib(dll) (release version, using FINAL=1)
 
 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
    (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
@@ -156,8 +158,9 @@ using templates, to avoid the non-template stream files being included
 within wxWindows.
 
 Note (2): libraries and applications generated with makefiles and
-project files are unlikely to be compatible, so use one method or
-the other.
+project files are now (hopefully) compatible where static libraries
+are concerned, but please exercise caution nevertheless and if
+possible, use one method or the other.
 
 Note (3): VC++ 5's optimization code seems to be broken and can
 cause both compile and run-time problems: this can be seen when
@@ -171,7 +174,12 @@ Code' (and no others). This will then work.
 
 Similarly, in VC++ 4, optimization can cause internal compiler
 errors, so edit src\makevc.env and change /O1 to /Od before
-trying build a release version of the library.
+trying build a release version of the library. Or, type:
+
+nmake -f makefile.vc noopt FINAL=1
+
+and then resume compilation in the normal way. This will build
+troublesome files with no optimization.
 
 Note (4): some crash problems can be due to inconsistent compiler
 options. If strange/weird/impossible things start to happen please
@@ -206,7 +214,7 @@ Compiling using the makefiles:
 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
    make the wxWindows core library. Ignore the warnings about
    'XXX' not found in library.
-3. Change directory to a sample such as minimal, and type
+3. Change directory to a sample or demo such as samples\minimal, and type
   'make -f makefile.b32'.
 4. For release versions, recompile wxWindows and samples using
    'make -f makefile.b32 clean'
@@ -236,6 +244,11 @@ Note (5): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
 you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
 the jpeg target from src\msw\makefile.b32.
 
+Note (6): If using C++Builder 4 and above (BC++ 5.4 and above), change LINK=tlink32 to
+LINK=ilink32 in src\makeb32.env. You may also need to disable
+wxUSE_LIBJPEG because there is a conflict in the BC++ headers
+(actually this problem seems to have gone away with 5.5 and SP1).
+
 Compiling using the IDE files:
 
 1. Load src\bc32.ide (Release settings)
@@ -251,11 +264,16 @@ Compiling using the IDE files:
    since some (notably the wxHTML samples) look for files
    relative to the working directory.
 
-Note that to make the png, xpm, zlib and jpeg libraries (needed for
+Note (1): the samples project file contains a selection of
+samples, and not all samples. The remaining samples can be made
+with the makefiles. See also the demos hierarchy which doesn't
+have any BC++ project files yet.
+
+Note (2): to make the png, xpm, zlib, jpeg and tiff libraries (needed for
 some samples) you need to compile them with bc32.ide.
 
-The debug version of the wxWindows library is about 37 MB, and the
-release version is around 3 MB.
+Note (3): the debug version of the wxWindows library is about 40 MB, and the
+release version is around 5 MB.
 
 See also the file bc_ide.txt for further instructions and details
 of how to create your own project files.
@@ -371,7 +389,7 @@ Here are the steps required:
   extra files to use the wxWindows makefiles. You can find these
   files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
   These should be extracted to the Mingw32 directory.
-  If you have already have downloaded bison, flex, make, rm, mv
+  If you have already have downloaded bison, flex, make, rm, cp, mv
   from elsewhere, you won't need this.
 
   If using Mingw32 2.8.1, see also see mingw32.txt in this directory
@@ -423,38 +441,30 @@ and other intermediate compiler files.
 
 Notes:
 
-- See also the Cygwin/Mingw32 on the web site or CD-ROM for
-  further information about using wxWindows with these compilers.
-
-- libwx.a is 48 MB or more - but much less if compiled with no
-  debug info (-g0) and level 4 optimization (-O4).
+1. See also the Cygwin/Mingw32 on the web site or CD-ROM for
+   further information about using wxWindows with these compilers.
 
-- install.exe doesn't have built-in decompression because lzexpand.lib
-  isn't available with Cygwin. However, you can use it with external
-  decompression utilities.
+2. libwx.a is 48 MB or more - but much less if compiled with no
+   debug info (-g0) and level 4 optimization (-O4).
 
-- There's a bug in Mingw32 headers for some early distributions.
+3. There's a bug in Mingw32 headers for some early distributions.
 
-  in include/windows32/defines.h, where it says:
+   in include/windows32/defines.h, where it says:
 
-  #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
+   #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
 
-  it should say:
+   it should say:
 
-  #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
+   #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
 
-  (a missing bracket).
+   (a missing bracket).
 
-- If there's a problem with the copy command in
-  src/msw/makefile.g95, you may need to change the relevant
-  section to the following:
+4. If there's a problem with the copy command in
+   src/msw/makefile.g95, you may need to change the COPY and
+   COPYSEP variables in makeg95.env.
 
-  COPY = command /c copy
-  $(COMMDIR)/y_tab.c:     $(COMMDIR)/dosyacc.c
-      $(COPY) ..\\common\\dosyacc.c ..\\common\\y_tab.c
-
-  $(COMMDIR)/lex_yy.c:    $(COMMDIR)/doslex.c
-      $(COPY) ..\\common\\doslex.c ..\\common\\lex_yy.c
+5. If there's a problem executing the windres program, try
+   commenting out RCPREPROCESSOR in makeg95.env.
 
 References:
 
@@ -496,3 +506,4 @@ General Notes
   include/wx/msw/setup.h is missing. This is deliberate, to avoid
   developers' different setup.h configurations getting confused.
   Please copy setup0.h to setup.h before compiling.
+