aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
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.