From 85dff7e1b224fd18f60c905ca59a1a421ca564fe Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Sat, 11 Apr 2015 15:50:27 -0700 Subject: [PATCH] Clarify the intro to the build.py commands in the README --- README.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 77a43d60..c4823563 100644 --- a/README.rst +++ b/README.rst @@ -109,13 +109,16 @@ packages. Important build.py commands --------------------------- -The following commands are required to be able to build Phoenix from scratch. -In other words, from a pristine source tree with none of the generated code -present yet. They can be run individually or you can specify all of them on a -single command line, in the order given. Once a command has succeded in one run -of build.py there is no need to run that command again in a later run, unless -you've changed something which that command has the responsibility to -process. +The following ``build.py`` commands are required to be able to build Phoenix +from scratch. In other words, from a pristine source tree with none of the +generated code present yet. They can be run individually or you can specify +all of them on a single command line, in the order given. Once a command has +succeded in one run of build.py there is no need to run that command again in +a later run, unless you've changed something which that command has the +responsibility to process. Many of the commands require the results of the +earlier commands, so at least the first time you run the build you will need +to use all 4 of the commands (or their equivalents for composite commands) in +the given order. * **dox**: Builds the XML files from the wxWidgets documentation source, which will be used as input for the etg command.