Add comment about the readme being for those building from a git checkout,

and point the reader to other sources for simpler instructions.
This commit is contained in:
Robin Dunn
2019-07-08 21:33:55 -07:00
parent 4b6f2b3896
commit e1549b79f2

View File

@@ -32,7 +32,21 @@ platform specific code.
How to build wxPython Phoenix How to build wxPython Phoenix
----------------------------- -----------------------------
First of all, review the section below about prerequisites. First of all, this README is intended primarily for those who want to build
wxPython from a workspace checked out from the wxPython Phoenix repository. If
you are not making changes to wxPython, or needing to build it for some
unsupported compiler or some other hardware architecture, then you probably do
not need to put yourself through the pain for building in this way. It's a
complicated build, and can sometimes be confusing even for the experts.
Instead, if the binaries available at PyPI are not what you need then you can
use pip to build from the released source archives, or from the source archives
created in the pre-release snapshot builds. See the notes about it at:
* https://wxpython.org/pages/downloads/
* https://wxpython.org/blog/2017-08-17-builds-for-linux-with-pip
Next, review the section below about prerequisites.
All aspects of the wxPython Phoenix build are managed through a series of 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 commands provided by the build.py script. There is also a setup.py script
@@ -256,7 +270,7 @@ explanation to help a newbie find their way around.
cd Phoenix cd Phoenix
git submodule init git submodule init
git submodule update git submodule update --recursively
* **sip/gen**: The code (.sip files) produced by the ETG scripts is placed * **sip/gen**: The code (.sip files) produced by the ETG scripts is placed
in this folder. in this folder.