Skip to content

Commit 9dda3ad

Browse files
Completed the docs covering pyqtdeploy-build.
1 parent 9dfa900 commit 9dda3ad

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

doc/building.rst

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,27 @@
55
Building the Application
66
========================
77

8-
TODO
8+
:program:`pyqtdeploy-build` uses the project file created by
9+
:program:`pyqtdeploy` to generate the target-specific source code, including
10+
the :program:`qmake` ``.pro`` files, needed to create the application. The
11+
simplest invocation is::
912

13+
pyqtdeploy-build pyqt-demo.pdy
1014

11-
The Command Line
12-
----------------
15+
The next step in the full build process would be to change to the build
16+
directory and run :program:`qmake`. The final step is target-specific. For
17+
Linux, macOS and Windows targets it is only necessary to run :program:`make`
18+
(or :program:`nmake` in the case of Windows). For an Android target it is
19+
necessary to run :program:`make` and Qt's :program:`androiddeployqt` utility.
20+
For an iOS target :program:`qmake` generates an Xcode project file. Xcode is
21+
then used to perform the final build.
1322

14-
:program:`pyqtdeploy-build` generates the target-specific source code,
15-
including the :program:`qmake` ``.pro`` files, needed to create the
16-
application. The next step in the full build process would be to run
17-
:program:`qmake`.
23+
The demo's :program:`build-demo.py` script takes care of (almost) all of this
24+
process automatically.
25+
26+
27+
Command Line Options
28+
--------------------
1829

1930
The full set of command line options is:
2031

@@ -85,7 +96,10 @@ The full set of command line options is:
8596
.. option:: --sysroot DIR
8697

8798
``DIR`` is the name of the system image root directory. The
88-
:envvar:`SYSROOT` environment variable is set to ``DIR`` during the build.
99+
:envvar:`SYSROOT` environment variable is set to ``DIR`` during the build
100+
replacing any existing value. The default value is ``sysroot-`` followed
101+
by a target-specific suffix, but this is not set if the :envvar:`SYSROOT`
102+
environment variable already has a value.
89103

90104
.. option:: --target TARGET
91105

@@ -107,5 +121,5 @@ The full set of command line options is:
107121

108122
.. option:: project
109123

110-
``project`` is the name of the project file created with
124+
``project`` is the name of the project file created by
111125
:program:`pyqtdeploy`.

0 commit comments

Comments
 (0)