aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorSergio Ahumada <sergio.ahumada@digia.com>2013-06-24 18:34:07 +0200
committerSergio Ahumada <sergio.ahumada@digia.com>2013-06-24 18:34:14 +0200
commitf3d6fe82ab8c1c2b4fda4f4a87a68e86cd1f2a4f (patch)
treefa5f507651e467a3b8281008535a9d38037e98e9 /README
parentdf0a7fd6dc0ce6d859e0c21231758c4e230ff189 (diff)
parent76e3f3d2a6648f3f18bb022f6ebc668d25ee525e (diff)
Merge branch 'stable' into dev
Conflicts: qtactiveqt qtbase qtdeclarative qtdoc qtgraphicaleffects qtimageformats qtjsbackend qtmultimedia qtquick1 qtquickcontrols qtscript qtsensors qtserialport qtsvg qttools qttranslations qtwebkit qtwebkit-examples qtx11extras qtxmlpatterns Change-Id: Ie3f5321de50ec76a7b3f5a0e2d2be1835abce527
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
index 06b57840..b21547cd 100644
--- a/README
+++ b/README
@@ -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.
See http://qt-project.org/wiki/Qt-5 for the reference platforms.
+
+
+ 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.