Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2025-12-16 09:40:07 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fix some typos, add a bit more text

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73914 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2013-05-04 02:01:07 +00:00
parent cd92ea7a90
commit ddf667c288
1 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.rst
View File

@@ -23,8 +23,8 @@ All aspects of the Phoenix build are managed through a series of commands
provided by the build.py script. There is also a setup.py script available 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 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 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 have already been performed, and so it is suitable for use when building from
source snapshot tarball or when using easy_install or pip. The seup.py a source snapshot tarball or when using easy_install or pip. The seup.py
script will delegate to build.py for the actual build, and build.py will 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 delegate to setup.py when doing setuptoolsy things like performing an install
or building an egg. or building an egg.
@@ -107,7 +107,7 @@ process.
put in the Phoenix/wx folder, and can be used from there without put in the Phoenix/wx folder, and can be used from there without
installation if desired. installation if desired.
Some other useful commands are: Some other useful commands and options are:
* **clean**: Clean up the build products produced by prior runs of * **clean**: Clean up the build products produced by prior runs of
build.py. There are additional clean commands that will let you clean up build.py. There are additional clean commands that will let you clean up
@@ -116,11 +116,11 @@ Some other useful commands are:
* **touch**: Updates the timestamp on all of the etg scripts, so they will * **touch**: Updates the timestamp on all of the etg scripts, so they will
be forced to be run in the next build. This is useful when a change has be forced to be run in the next build. This is useful when a change has
been made to the wxWidgets documentation that needs to be propagated been made to the wxWidgets documentation that needs to be propagated
through the build sinc ethe etg command doesn't yet do full dependency through the build since the etg command doesn't yet do full dependency
checking of the input. checking of the input.
* **M.N**: This is the Major.Minor version number of the Python that the * **M.N**: This is the Major.Minor version number of the Python that the
extension modules will be build for, such as "3.3". This allows you to run extension modules will be built for, such as "3.3". This allows you to run
build.py with a different Python than what you are building for, which is 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 handy for things like buildbots running in a virtualenv for one Python
that need to be able to run builds for other versions too. that need to be able to run builds for other versions too.
@@ -129,6 +129,18 @@ Some other useful commands are:
on the command line then you can specify the full path to the python on the command line then you can specify the full path to the python
executable you want to use with the ``--python`` option. executable you want to use with the ``--python`` option.
* **test**: Runs all of Phoenix's unittests.
* **--nodoc**: This option turns off the sphinx generator when running the
etg scripts. If you don't plan on generating the documentation then this
will speed up the proccessing of the etg command.
Please see the output of ``python build.py --help`` to see information about
commands and options not mentioned here. And, as always, if there is any
discrepancy between this document and the source code in the build.py script,
then the source code is right. ;-)
Project directory structure Project directory structure
@@ -137,9 +149,8 @@ Project directory structure
There are a lot of subfolders in this directory, here is a brief There are a lot of subfolders in this directory, here is a brief
explanation to help a newbie find their way around. explanation to help a newbie find their way around.
* **build**: Intermediate files produced by the build process (distutils, * **build**: Intermediate files produced by the build process are stored
etc.) are stored here. This folder should not be committed to a version here. This folder should not be committed to a version repository.
repository.
* **buildtools**: This is a Python package containing modules that are used * **buildtools**: This is a Python package containing modules that are used
from build.py and setup.py and which assist with configuring and running from build.py and setup.py and which assist with configuring and running
@@ -173,7 +184,7 @@ explanation to help a newbie find their way around.
anything else) that is edited by hand instead of being generated by some anything else) that is edited by hand instead of being generated by some
tool. tool.
* **wx**: This is the top of the wxPython package. For an in-place buld the * **wx**: This is the top of the wxPython package. For an in-place build the
extension modules and any associated files will be put into this folder. extension modules and any associated files will be put into this folder.
Subfolders contain pure-python subpackages of the wx package, such as Subfolders contain pure-python subpackages of the wx package, such as
wx.lib, etc. wx.lib, etc.