]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/docs/INSTALL.html
Adding overview docs and a couple tweaks to the demo.
[wxWidgets.git] / wxPython / docs / INSTALL.html
index 574016aeec9fe91097a25b713c09a9363d151a1b..c257f64145e6e7fe084246791842533fcb5f7a0f 100644 (file)
@@ -3,53 +3,53 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-<meta name="generator" content="Docutils 0.3.1: http://docutils.sourceforge.net/" />
-<title>Installing wxPython 2.5 from Source</title>
+<meta name="generator" content="Docutils 0.4.1: http://docutils.sourceforge.net/" />
+<title>Installing wxPython 2.8 from Source</title>
 <link rel="stylesheet" href="default.css" type="text/css" />
 </head>
 <body>
-<div class="document" id="installing-wxpython-2-5-from-source">
-<h1 class="title">Installing wxPython 2.5 from Source</h1>
+<div class="document" id="installing-wxpython-2-8-from-source">
+<h1 class="title">Installing wxPython 2.8 from Source</h1>
 <p>This document will describe the few differences and additions to the
-content in BUILD.txt for installing wxPython built from source.
-Please follow the intstructions both in this file and in BUILD.txt to
-perform this task.  Where there is overlap the items described here
-will take precedence.</p>
-<div class="section" id="installing-on-unix-like-systems-not-os-x">
-<h1><a name="installing-on-unix-like-systems-not-os-x">Installing on Unix-like Systems (not OS X)</a></h1>
+content in the <a class="reference" href="BUILD.html">BUILD</a> document for installing wxPython built from
+source.  Please follow the intstructions both in this file and in
+<a class="reference" href="BUILD.html">BUILD</a> to perform this task.  Where there is overlap the items
+described here will take precedence for doing installations.</p>
+<div class="section">
+<h1><a id="installing-on-unix-like-systems-not-os-x" name="installing-on-unix-like-systems-not-os-x">Installing on Unix-like Systems (not OS X)</a></h1>
 <ol class="arabic">
-<li><p class="first">When building wxWindows you need to decide if you want it to be a
+<li><p class="first">When building wxWidgets you need to decide if you want it to be a
 private copy only accessed by wxPython, or if you would like it to
 be installed in a stanard location such as /usr.  Or perhaps you
-already have a version of wxWindows installed on your system (such
+already have a version of wxWidgets installed on your system (such
 as from an RPM) and you want wxPython to use that version too.  If
 so then you'll want to ensure that the flags and options used to
 build the installed version are compatible with wxPython.</p>
 </li>
-<li><p class="first">If you do decide to build and install your own wxWindows then there
+<li><p class="first">If you do decide to build and install your own wxWidgets then there
 are a few tweaks to the configure flags described in BUILD.txt that
 you will probably want to make.  Instead of --enable-debug use
 this configure flag:</p>
 <pre class="literal-block">
 --enable-optimize \
 </pre>
-<p>Normally I also use the following flag in order to have wxWindows
+<p>Normally I also use the following flag in order to have wxWidgets
 runtime assertions turned into Python exceptions where possible.
 It does add extra code to the build but probably not enough to
 worry about it.  However if you want to get as lean a build as
 possible you can leave it out, but if your code does something bad
-then instead of exceptions you'll likely get a crash.</p>
-<blockquote>
-<p>--enable-debug_flag </p>
-</blockquote>
-<p>If you are building a private copy of wxWindows (IOW, not installed
+then instead of exceptions you'll likely get a crash:</p>
+<pre class="literal-block">
+--enable-debug_flag \
+</pre>
+<p>If you are building a private copy of wxWidgets (IOW, not installed
 in a standard library location) then it can be kind of a hassle to
 always have to set the LD_LIBRARY_PATH variable so wxPython can
-find the wxWindows shared libraries.  You can hard code the library
+find the wxWidgets shared libraries.  You can hard code the library
 path into the binaries by using the rpath option when configuring
-wxWindows.  For example:</p>
+wxWidgets.  For example:</p>
 <pre class="literal-block">
---enable-rpath=/opt/wx/2.5/lib \
+--enable-rpath=/opt/wx/2.8/lib \
 </pre>
 <p>SOLARIS NOTE: The --enable-rpath option may cause problems when
 using wxGTK on Solaris when compiling wxPython as described below.
@@ -65,9 +65,11 @@ all.</p>
 </li>
 <li><p class="first">In addition to building wxPython as described in BUILD.txt, you can
 install it to Python's site-packages dir, as well as some scripts
-into the same bin dir used by Python by using this command:</p>
+into the same bin dir used by Python by using this command, plus
+whatever WXPORT, UNICODE, etc. settings you used for the initial
+build step:</p>
 <pre class="literal-block">
-python2.3 setup.py install
+python2.5 setup.py install
 </pre>
 <p>If you would like to install to some place besides the prefix where
 Python is installed, (such as to your home directory) then you can
@@ -79,15 +81,15 @@ contained in the PYTHONPATH environment variable.</p>
 </li>
 </ol>
 </div>
-<div class="section" id="installing-on-os-x">
-<h1><a name="installing-on-os-x">Installing on OS X</a></h1>
+<div class="section">
+<h1><a id="installing-on-os-x" name="installing-on-os-x">Installing on OS X</a></h1>
 <p>Installing wxPython on OS X is nearly the same as the Unix
 instructions above, except for a few small, but important details:</p>
 <ol class="arabic simple">
 <li>The --enable-rpath configure option is not needed since the path to
-the wxWindows dylibs will automatically be encoded into the
+the wxWidgets dylibs will automatically be encoded into the
 extension modules when they are built.  If you end up moving the
-wxWindows dynlibs to some other location (such as inside the .app
+wxWidgets dynlibs to some other location (such as inside the .app
 bundle of your applicaiton for distribution to other users,) then
 you will need to set DYLD_LIBRARY_PATH to this location so the
 dylibs can be found at runtime.</li>
@@ -97,46 +99,43 @@ install MacPython-OSX-2.3 from <a class="reference" href="http://www.python.org/
 Python Framework will then be installed in /Library/Frameworks.  On
 10.3 (Panther) Apple supplies the Python Framework as part of the
 OS install, but it will be located in /System/Library/Frameworks
-instead.  However, on Panther the site-pacakges dir is sym-linked
-to /Library/Python/2.3 so the wxPython pacakges will end up there,
+instead.  However, on Panther the site-packages dir is sym-linked
+to /Library/Python/2.3 so the wxPython packages will end up there,
 although they will still be visible from site-packages.  If you are
 building distributions of wxPython to be installed on other
 machines be careful to install to /Library/Python/2.3.  To
 complicate things further, the Jaguar version, or a custom build
 you do yourself will end up in /Library/Frameworks even on
 Panther...</li>
-<li>You need to use pythonw at the command line or PythonLauncher app
-to run wxPython apps, otherwise the app will not be able to fully
-use the GUI display.</li>
+<li>You need to use pythonw at the command line or the PythonLauncher
+app to run wxPython apps, otherwise the app will not be able to
+fully use the GUI display.</li>
 </ol>
 </div>
-<div class="section" id="installing-on-windows">
-<h1><a name="installing-on-windows">Installing on Windows</a></h1>
+<div class="section">
+<h1><a id="installing-on-windows" name="installing-on-windows">Installing on Windows</a></h1>
 <ol class="arabic">
-<li><p class="first">Build wxWindows and wxPython as described in BUILD.txt.  If you
+<li><p class="first">Build wxWidgets and wxPython as described in BUILD.txt.  If you
 would rather have a version without the code that turns runtime
 assertions into Python exceptions, then use &quot;release&quot; instead of
-&quot;hybrid&quot; when building wxWindows and add &quot;FINAL=1&quot; to the setup.py
+&quot;hybrid&quot; when building wxWidgets and add &quot;FINAL=1&quot; to the setup.py
 command line.</p>
 </li>
-<li><p class="first">Install wxPython like this:</p>
+<li><p class="first">Install wxPython like this.  Remember to add any additional flags
+you added for the build such as UNICODE or USE_SWIG:</p>
 <pre class="literal-block">
 python setup.py install
 </pre>
 </li>
-<li><p class="first">Copy the wxWindows DLLs to the wx package directory so they can be
+<li><p class="first">Copy the wxWidgets DLLs to the wx package directory so they can be
 found at runtime by the extension modules without requiring that
 they be installed on the PATH:</p>
 <pre class="literal-block">
-copy %WXWIN%\BIN\wx*h_*.dll c:\Python23\Lib\site-pacakges\wx
+copy %WXWIN%\\lib\\vc_dll\\wx*h_*.dll c:\\Python25\\Lib\\site-packages\\wx
 </pre>
 </li>
 </ol>
 </div>
 </div>
-<hr class="footer" />
-<div class="footer">
-Generated on: 2004-02-04 23:31 UTC.
-</div>
 </body>
 </html>