Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2025-07-21 04:31:09 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README.rst (#2593)

Browse Source 
* update README.rst

* fix typos, clean up references to out-dated build tools

* better links for GH Issues, wxPython discuss
This commit is contained in:
Matt Newville
2024-08-30 15:38:39 -05:00
committed by GitHub
parent c2f6459f12
commit 99d71bba4b
1 changed files with 27 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
README.rst
View File

@@ -29,6 +29,16 @@ platform specific code.
.. contents:: **Contents**
Development at GitHub.com
-----------------------------
Development of wxPython is done with git, using
https://github.com/wxWidgets/Phoenix as the main development site.
Currently (September, 2024), only 2 developers (@swt2c, @RobinD42) can merge
pull requests, or assign others to review pull requests.
How to build wxPython Phoenix
-----------------------------
@@ -50,13 +60,11 @@ Next, review the section below about prerequisites.
All aspects of the wxPython Phoenix build are managed through a series of
commands provided by the build.py script. There is also a setup.py script
available for those who are used to the standard distutils or setuptools types
of builds. The setup.py script assumes that all of the code generation steps
have already been performed, and so it is suitable for use when building from
a source snapshot tarball or when using easy_install or pip. The setup.py
script will delegate to build.py for the actual build, and build.py will
delegate to setup.py when doing setuptoolsy things like performing an install
or building a wheel.
available for builds using setuptools. The setup.py script assumes that all of
the code generation steps have already been performed, and so it is suitable
for use when building from a source snapshot tarball or when using pip. The
setup.py script will delegate to build.py for the actual build, and build.py
will delegate to setup.py when using pip or building a wheel.
Using the build.py script allows for greater control over the build process
than setup.py does, including commands for performing the various
@@ -187,7 +195,7 @@ Some other useful commands and options are:
checking of the input.
* **M.N**: This is the Major.Minor version number of the Python that the
extension modules will be built for, such as "3.3". This allows you to run
extension modules will be built for, such as "3.11". This allows you to run
build.py with a different Python than what you are building for, which is
handy for things like buildbots running in a virtualenv for one Python
that need to be able to run builds for other versions too.
@@ -329,22 +337,14 @@ a PR for updating this document.
**Windows**
All the source code needed for wxWidgets and wxPython Phoenix are
included in the wxWidgets and Phoenix source trees. In addition to a
stock Python installation you will also need a copy of Visual Studio 2008
(for Python2.7 compatibility) or Visual Studio 2015 (for Python 3.x
support). It should also be possible to build using Mingw32, but there
will need to be some changes made to the build scripts to support that.
All the source code needed for wxWidgets and wxPython Phoenix are included in
the wxWidgets and Phoenix source trees. In addition to a stock Python
installation you will also need a copy Visual Studio 2015. It may be possible
to build using Mingw32, but there will need to be some changes made to the
build scripts to support that.
You may also want to get a copy of the MS SDK in order to have newer
definitions of the Windows API. I typically use 7.0 or 7.1 with Visual
Studio 2008.
Unfortunately Microsoft no longer distributes Visual Studio 2008. But don't
panic! They have recently made available a "Microsoft Visual C++ Compiler for
Python 2.7" package, which can also be used for building Phoenix for Python
2.7. Plus it's free! You can get it at:
http://www.microsoft.com/en-us/download/details.aspx?id=44266
definitions of the Windows API.
If you want to build Phoenix with debug info then you will need to first
build a debug version of Python, and then use that Python (python_d.exe) to
@@ -384,7 +384,7 @@ their dependencies:
* libwebkitgtk-dev
If You use a custom built python in a non standard location, You need to
If you use a custom built python in a non standard location, You need to
compile python with the --enable-shared option.
**Mac OSX**
@@ -400,9 +400,7 @@ package.
Also like on Windows, using the same or similar compiler that was used to
build Python usually helps things to work better and have a better chance
for success. For example, the stock Python 2.7 will try to use "gcc-4.2"
when building extensions, but newer versions of Xcode may not have that
command available. I am currently using Xcode 7.1.1.
for success.
If all else fails it is not too hard to build Python yourself using
whatever Xcode you have installed, and then use that Python when building
@@ -412,10 +410,9 @@ Phoenix.
Help and Helping
----------------
Most discussions about Phoenix happen on the wxPython-dev google group
(a.k.a. the wxPython-dev mail list.) If you have questions or would like to
get involved please subscribe to the group at
https://groups.google.com/forum/#!forum/wxpython-dev and join in.
Please use `GitHub issues <https://github.com/wxWidgets/Phoenix/issues>`_
to report bugs. Discussions about Python usage happen at
`Discuss wxPython <https://discuss.wxpython.org/>`_.
Latest Snapshot Builds