diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-01-23 12:33:03 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-01-25 15:44:40 +0100 |
| commit | 6623ffc4ec271ae5769382d1f6cbd7e475089270 (patch) | |
| tree | 742ea6a28744746c38c13a736bfb15b2df496202 /README | |
| parent | 2f43917c1d4b3648615c52d4fe012d44561e5d0c (diff) | |
Doc: Added information about the documentation in qt5/README file.
-added basic information and links to wiki and qtbase/doc/README file.
Task-number: QTBUG-29057
Change-Id: I21d4dbaf7c1d03b63949af1fa303cb6fcbee8949
Reviewed-by: Johanna Äijälä <johanna.aijala@digia.com>
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -122,3 +122,22 @@ HOW TO BUILD QT5 ===================== See http://qt-project.org/wiki/Building-Qt-5-from-Git and README.git for more information. + + + Documentation + ============= + + After the configure step, building the documentation is possible by running + "make docs". + Example: + + ./configure -prefix $PWD/qtbase -opensource + make docs + + The documentation is installed in the path set to $QT_INSTALL_DOCS. + Running "qmake -query" will list the value of QT_INSTALL_DOCS. + + Information about Qt 5's documentation is located in qtbase/doc/README + or in the following page: http://qt-project.org/wiki/Qt5DocumentationProject + + Note: Building the documentation is only tested on desktop platforms. |