]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/msw/install.txt
The mmedia contrib requires sys/soundcard.h on unix, so disable it on unix
[wxWidgets.git] / docs / msw / install.txt
index 3bc210b02b67a5108283bd676def3bcdffc83ab7..6e942f8ffb624b8f4a49db3d8363cf28b24960cc 100644 (file)
@@ -1,10 +1,11 @@
-Installing wxWidgets 2.5.1
---------------------------
+Installing wxWidgets 2.6.0
+-----------------------------------------------------------
 
-This is wxWidgets 2.5.1 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
-and Windows XP. This is an unstable development release. Note that unstable in
-this context doesn't mean that it crashes a lot, just that the library API may
-change in backwards incompatible way during the 2.5 branch lifetime.
+This is wxWidgets 2.6.0 for Microsoft Windows 9x/ME, Windows NT,
+Windows 2000, Windows XP and Windows CE.
+
+These installation notes can be found in docs/msw/install.txt
+in your wxWidgets distribution.
 
 IMPORTANT NOTE: If you experience problems installing, please
 re-read this instructions and other related files (changes.txt,
@@ -19,7 +20,7 @@ Please report bugs using the SourceForge bug tracker:
   http://sourceforge.net/bugs/?group_id=9863
 
 Unarchiving
-===========
+============================================================
 
 A setup program is provided (setup.exe) to automatically copy
 files to a directory on your hard disk. Do not install into a
@@ -61,7 +62,7 @@ All makefiles and project are located in build\msw directory.
 Where compiled files are stored
 -------------------------------
 
-After succesful compilation you'll find the libraries in a subdirectory
+After successful compilation you'll find the libraries in a subdirectory
 of lib directory named after the compiler and DLL/static settings.
 A couple of examples:
 
@@ -107,7 +108,7 @@ Below are compiler specific notes followed by customizing instructions that
 apply to all compilers (search for "Configuring the build").
 
 Microsoft Visual C++ compilation
---------------------------------
+----------------------------------------------------------------
 
 You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
 informal and more detailed description of the process summarized below.
@@ -186,7 +187,7 @@ files from an existing wxWidgets sample and adapt them, or
 visit http://wiki.wxwindows.org/wiki.pl?MSVC.
 
 Borland C++ 5.0/5.5 compilation
--------------------------------
+----------------------------------------------------------------
 
 Compiling using the makefiles (updated 24 Sept 02):
 
@@ -230,13 +231,13 @@ the following preprocessor directive:
 more details)
 
 Borland 16 Bit compilation for Windows 3.1
-------------------------------------------
+----------------------------------------------------------------
 
 The last version of wxWidgets to support 16-bit compilation with Borland was
 2.2.7 - Please download and read the instructions in that release
 
 Watcom C++ 10.6/11 and OpenWatcom compilation
----------------------------------------------
+----------------------------------------------------------------
 
 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
    make the wxWidgets core library.
@@ -260,10 +261,10 @@ Note (4): if Watcom can't read the precompiled header when building a sample,
           the sample again.
 
 Metrowerks CodeWarrior compilation
-----------------------------------
+----------------------------------------------------------------
 
-1. CodeWarrior Pro7 project files in XML format are already
-   included in wxMSW-2.5.1.zip and the setup version.
+1. CodeWarrior Pro 7 project files in XML format are already
+   included in wxMSW-2.6.0.zip and the setup version.
 
 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
    you are working from the CVS version) to make sure the settings reflect
@@ -324,9 +325,9 @@ Metrowerks CodeWarrior compilation
 
 
 Cygwin/MinGW compilation
-------------------------
+----------------------------------------------------------------
 
-wxWidgets supports Cygwin (formerly GnuWin32) betas and
+wxWidgets supports Cygwin (formerly GnuWin32) betas and
 releases, and MinGW. Cygwin can be downloaded from:
 
     http://sources.redhat.com/cygwin/
@@ -353,12 +354,12 @@ If using MinGW, you can download the add-on MSYS package to
 provide Unix-like tools that you'll need to build wxWidgets using configure.
 
 Using makefiles directly
-------------------------
+----------------------------------------------------------------
 
-NOTE: The makefile are for compilation under Cygwin, or
-      command.com/cmd.exe, they won't work in other environments
-      (such as UNIX or Unix-like, e.g. MSYS, you have to use configure
-      instead)
+NOTE: The makefile.gcc makefiles are for compilation under MinGW using
+      native make and Windows command interpreter (command.com/cmd.exe), they
+      won't work in other environments (such as UNIX or Unix-like, e.g. MSYS;
+      you have to use configure instead)
 
 Here are the steps required using the provided makefiles:
 
@@ -385,7 +386,7 @@ All targets have 'clean' targets to allow removal of object files
 and other intermediate compiler files.
 
 Using configure
----------------
+----------------------------------------------------------------
 
 Instead of using the makefiles, you can use the configure
 system to generate appropriate makefiles, as used on Unix
@@ -479,7 +480,8 @@ OLD VERSIONS:
 
 
 Symantec & DigitalMars C++ compilation
---------------------------------------
+----------------------------------------------------------------
+
 The DigitalMars compiler is a free succssor to the Symantec compiler
 and can be downloaded from http://www.digitalmars.com/
    
@@ -507,7 +509,7 @@ using bakefile tool according to the instructions in build\bakefiles\README:
 16-bit compilation is no longer supported.
 
 Configuring the build
-=====================
+================================================================
 
 So far the instructions only explained how to build release DLLs of wxWidgets
 and did not cover any configuration. It is possible to change many aspects of
@@ -517,7 +519,7 @@ and the only difference between them is in object files and library directory
 names and in make invocation command.
 
 Changing the settings
----------------------
+----------------------------------------------------------------
 
 There are two ways to modify the settings: either by passing the values as
 arguments when invoking make or by editing build\msw\config.$(compiler) file
@@ -555,16 +557,17 @@ Brief explanation of options and possible values is in every
 build\msw\config.* file; more detailed description follows.
 
 Basic options
--------------
+----------------------------------------------------------------
 
-BUILD=debug
-  Builds debug version of the library (default is 'release'). This affects
-  name of the library ('d' is appended), __WXDEBUG__ is defined and debug
-  information compiled into object files and the executable.
+BUILD=release
+  Builds release version of the library. It differs from default 'debug' 
+  in lack of appended 'd' in name of library, does not define __WXDEBUG__
+  and not include debug information compiled into object files and the 
+  executable.
 
-SHARED=0
-  Build static libraries instead of DLLs. By default, DLLs are built
-  (SHARED=1).
+SHARED=1
+  Build shared libraries (DLLs). By default, DLLs are not built
+  (SHARED=0).
 
 UNICODE=1
   To build Unicode versions of the libraries, add UNICODE=1 to make invocation
@@ -579,7 +582,7 @@ WXUNIV=1
   http://www.wxwidgets.org/wxuniv.htm for more information).
 
 Advanced options
-----------------
+----------------------------------------------------------------
 
 MONOLITHIC=1
   Starting with version 2.5.1, wxWidgets has the ability to be built as 
@@ -609,6 +612,10 @@ USE_HTML=0
   Do not build wxHTML library. If MONOLITHIC=1, then you must also
   #define wxUSE_HTML 1 in setup.h.
 
+USE_XRC=0
+  Do not build XRC resources library. If MONOLITHIC=1, then you must also
+  #define wxUSE_HTML 1 in setup.h.
+
 RUNTIME_LIBS=static
   Links static version of C and C++ runtime libraries into the executable, so
   that the program does not depend on DLLs provided with the compiler (e.g.
@@ -653,7 +660,7 @@ CFG=<configuration name>
   directories" below for more information.
 
 Compiler specific options
--------------------------
+----------------------------------------------------------------
 
 * MinGW
 
@@ -675,7 +682,7 @@ DEBUG_RUNTIME_LIBS=1
   setting makes it possible.
 
 Fine-tuning the compiler
-------------------------
+----------------------------------------------------------------
 
 All makefiles have variables that you can use to specify additional options
 passed to the compiler or linker. You won't need this in most cases, but if you
@@ -683,7 +690,7 @@ do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
 compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
 
 Object and library directories
-------------------------------
+----------------------------------------------------------------
 
 All object files produced during library build are stored in a directory under
 build\msw. It's name is derived from build settings and CFG variable and from
@@ -733,7 +740,7 @@ enabled (without CFG, both of them would be put into same directory and there
 would be conflicts between the files).
 
 General Notes
-=============
+=================================================================
 
 - Debugging: under Windows 95, debugging output isn't output in
   the same way that it is under NT or Windows 3.1.