Added wx.FileSystem support

[wxWidgets.git] / wxPython / docs / BUILD.txt

diff --git a/wxPython/docs/BUILD.txt b/wxPython/docs/BUILD.txt
index 9feec788f1055594764e51804dfd935f93f07a0f..02702fe52e6c323926a469b729f47312b580c702 100644 (file)
--- a/wxPython/docs/BUILD.txt
+++ b/wxPython/docs/BUILD.txt
@@ -42,6 +42,16 @@ the wxPythonSrc tarball to.  You can either substitute the $WXDIR text
 below with your actual dir, or set the value in the environment and
 use it just like you see it below.
 
 below with your actual dir, or set the value in the environment and
 use it just like you see it below.
 

+If you run into what appears to be compatibility issues between
+wxWidgets and wxPython while building wxPython, be sure you are using
+the wxWidgets sources included with the wxPythonSrc tarball or the CVS
+snapshot, and not a previously installed version or a version
+installed from one of the standard wxWidgets installers.  With the
+"unstable" releases (have a odd-numbered minor release value, where
+the APIs are allowed to change) there are often significant
+differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
+release of wxPython.
+

 
 
 Building on Unix-like Systems (e.g. Linux and OS X)
 
 
 Building on Unix-like Systems (e.g. Linux and OS X)


@@ -137,7 +147,7 @@ place, then do the same for wxPython.
    these commands, so it won't impact your already installed version
    of the latest release.  You'll be able test with this version when
    you want to, and use the installed release version the rest of the
    these commands, so it won't impact your already installed version
    of the latest release.  You'll be able test with this version when
    you want to, and use the installed release version the rest of the

-   time.  If do want to install the development verison please read
+   time.  If you want to install the development version please read

    INSTALL.txt.
 
    If you have more than one version of Python on your system then be
    INSTALL.txt.
 
    If you have more than one version of Python on your system then be


@@ -169,10 +179,10 @@ place, then do the same for wxPython.
 
          USE_SWIG=1 SWIG=/opt/swig/bin/swig
 
 
          USE_SWIG=1 SWIG=/opt/swig/bin/swig
 

-   If you get errors about wxGLCanvas or being unable to find libGLU
-   or something like that then you can add BUILD_GLCANVAS=0 to the
-   setup.py command line to disable the building of the glcanvas
-   module.
+   If you get errors about being unable to find libGLU, wxGLCanvas
+   being undeclared, or something similar then you can add
+   BUILD_GLCANVAS=0 to the setup.py command line to disable the
+   building of the glcanvas module.

 
    When the setup.py command is done you should have fully populated
    wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
 
    When the setup.py command is done you should have fully populated
    wxPython and wx packages locally in $WXDIR/wxPython/wxPython and


@@ -180,7 +190,7 @@ place, then do the same for wxPython.
    located in the wx package.
 
 
    located in the wx package.
 
 

-4. To run code with the development verison of wxPython, just set the
+4. To run code with the development version of wxPython, just set the

    PYTHONPATH to the wxPython dir located in the source tree.  For
    example::
 
    PYTHONPATH to the wxPython dir located in the source tree.  For
    example::
 


@@ -226,7 +236,7 @@ wxPython extensions that I distribute are built with MSVC 6 with all
 the Service Packs applied.  This policy will change with Python 2.4
 and MSVC 7.1 will be used starting with that version.
 
 the Service Packs applied.  This policy will change with Python 2.4
 and MSVC 7.1 will be used starting with that version.
 

-If you want to build a debugable version of wxWidgets and wxPython you
+If you want to build a debuggable version of wxWidgets and wxPython you

 will need to have also built a debug version of Python and any other
 extension modules you need to use.  You can tell if you have them
 already if there is a _d in the file names, for example python_d.exe
 will need to have also built a debug version of Python and any other
 extension modules you need to use.  You can tell if you have them
 already if there is a _d in the file names, for example python_d.exe


@@ -241,7 +251,7 @@ to use my scripts you'll need to get a copy or 4DOS or 4NT from
 http://www.jpsoft.com/ and also a copy of unix-like cat and sed
 programs.  You can also do by hand what my scripts are doing, but
 there are alot of steps involved and I won't be going into details
 http://www.jpsoft.com/ and also a copy of unix-like cat and sed
 programs.  You can also do by hand what my scripts are doing, but
 there are alot of steps involved and I won't be going into details

-here.  There is a copy of my build scripts in %WXDIR%\wxPython\distrib\msw
+here.  There is a copy of my build scripts in %WXDIR%\\wxPython\\distrib\\msw

 that you can use for reference (if you don't use them directly) for
 adapting these instructions to your specific needs.  The directions
 below assume that you are using my scripts.
 that you can use for reference (if you don't use them directly) for
 adapting these instructions to your specific needs.  The directions
 below assume that you are using my scripts.


@@ -252,13 +262,13 @@ below assume that you are using my scripts.
 
          set WXWIN=%WXDIR%
 
 
          set WXWIN=%WXDIR%
 

-2. Copy setup0.h to setup.h
+2. Copy setup0.h to setup.h::

 
          cd %WXDIR%\include\wx\msw
          copy setup0.h setup.h
 
 
 
          cd %WXDIR%\include\wx\msw
          copy setup0.h setup.h
 
 

-3. Edit %WXDIR%\include\wx\msw\setup.h and change a few settings.
+3. Edit %WXDIR%\\include\\wx\\msw\\setup.h and change a few settings.

    Some of them are changed by my build scripts depending on the type
    of build (debug/hybrid, unicode/ansi). I change a few of the other
    defaults to have these values::
    Some of them are changed by my build scripts depending on the type
    of build (debug/hybrid, unicode/ansi). I change a few of the other
    defaults to have these values::


@@ -273,13 +283,13 @@ below assume that you are using my scripts.
          wxUSE_DISPLAY                  1
          
 
          wxUSE_DISPLAY                  1
          
 

-4. Make sure that %WXDIR%\lib\vc_dll directory is on the PATH.  The
+4. Make sure that %WXDIR%\\lib\\vc_dll directory is on the PATH.  The

    wxWidgets DLLs will end up there as part of the build and so you'll
    need it on the PATH for them to be found at runtime.
 
 
    wxWidgets DLLs will end up there as part of the build and so you'll
    need it on the PATH for them to be found at runtime.
 
 

-5. Change to the %WXDIR%\build\msw directory and copy my build scripts
-   there from their default location in %WXDIR%\wxPython\distrib\msw
+5. Change to the %WXDIR%\\build\\msw directory and copy my build scripts
+   there from their default location in %WXDIR%\\wxPython\\distrib\\msw

    if they are not present already.
 
 
    if they are not present already.
 
 


@@ -306,9 +316,8 @@ below assume that you are using my scripts.
 
 
 7.  When that is done it will have built the main wxWidgets DLLs and
 
 
 7.  When that is done it will have built the main wxWidgets DLLs and

-    also some of the contribs DLLs.  There should be a ton of DLLs in
-    %WXDIR%\bin and lots of lib files and other stuff in
-    %WXDIR%\lib\vc_dll.
+    also some of the contribs DLLs.  There should be a ton of DLLs and
+    lots of lib files and other stuff in %WXDIR%\\lib\\vc_dll.

 
 
 8. Building wxPython on Windows is very similar to doing it for the
 
 
 8. Building wxPython on Windows is very similar to doing it for the


@@ -317,9 +326,9 @@ below assume that you are using my scripts.
    installed version of the latest release.  You'll be able to test
    with this version when you want to, and use the installed release
    version the rest of the time.  If you ever do want to install the
    installed version of the latest release.  You'll be able to test
    with this version when you want to, and use the installed release
    version the rest of the time.  If you ever do want to install the

-   development verison please refer to INSTALL.txt.
+   development version please refer to INSTALL.txt.

 
 

-   Change to the %WXDIR%\wxPython dir and run the this command,
+   Change to the %WXDIR%\\wxPython dir and run the this command,

    makeing sure that you use the version of python that you want to
    build for (if you have more than one on your system)::
 
    makeing sure that you use the version of python that you want to
    build for (if you have more than one on your system)::
 


@@ -349,7 +358,7 @@ below assume that you are using my scripts.
    files) located in the wx package.
 
 
    files) located in the wx package.
 
 

-9. To run code with the development verison of wxPython, just set the
+9. To run code with the development version of wxPython, just set the

    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
         set PYTHONPATH=%WXDIR%\wxPython
    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
         set PYTHONPATH=%WXDIR%\wxPython