From 6623ffc4ec271ae5769382d1f6cbd7e475089270 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 23 Jan 2013 12:33:03 +0100 Subject: Doc: Added information about the documentation in qt5/README file. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -added basic information and links to wiki and qtbase/doc/README file. Task-number: QTBUG-29057 Change-Id: I21d4dbaf7c1d03b63949af1fa303cb6fcbee8949 Reviewed-by: Johanna Äijälä Reviewed-by: Sergio Ahumada --- README | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README') diff --git a/README b/README index b1c97a49..802c3545 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. + + + 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. -- cgit v1.2.3