Skip to content

Commit

Permalink
Doc: Added information about the documentation in qt5/README file.
Browse files Browse the repository at this point in the history
-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>
  • Loading branch information
jeromepasion authored and The Qt Project committed Jan 25, 2013
1 parent 2f43917 commit 6623ffc
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 6623ffc

Please sign in to comment.