Files

Mats Honkamaa cbcdf4c2f2 Doc: Update create project docs

Update docs to include new project wizard.

Task-number: QDS-5939
Change-Id: Ic152f5d558c81ae8c5ce536ef26e8c9461a81c34
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Tanja Remes <tanja.remes@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>

2022-01-14 08:05:57 +00:00

config

Doc: Copy icons from sources to images\icons

2022-01-04 11:07:44 +00:00

examples

Doc: Add snow and rain particle tutorial

2022-01-13 13:24:57 +00:00

images

Doc: Update create project docs

2022-01-14 08:05:57 +00:00

src

Doc: Update create project docs

2022-01-14 08:05:57 +00:00

qtdesignstudio-online.qdocconf

Doc: Fix the \youtube macro for use with liteHTML help backend

2020-12-01 10:40:02 +00:00

qtdesignstudio.qdocconf

Doc: Add Qt Design Studio Manual sources

2020-01-20 13:54:38 +00:00

README.md

Doc: Update guidelines for writing Qt Creator documentation

2020-04-02 07:07:52 +00:00

studiodoc.pro

Doc: Add Qt Design Studio Manual sources

2020-01-20 13:54:38 +00:00

README.md

Writing Qt Design Studio Documentation

The Qt Design Studio Manual is based on the Qt Creator Manual, with additional topics. When building the Qt Design Studio Manual, parts of the Qt Creator Manual are pulled in from Qt Creator sources. This is enabled by creating separate table of contents files for each Manual and by using defines to hide and show information depending on which Manual is being built.

Because branding information is needed to use the correct product name and version, you must run qmake -r on qtcreator.pro with the IDE_BRANDING_PRI option set to the absolute path of ide_branding.pri in the Qt Design Studio repository.

For example, on Windows enter (all on one line):

C:\dev\qtc-super\qtcreator>..\..\..\Qt\5.14.1\msvc2017_64\bin\qmake.exe qtcreator.pro -r IDE_BRANDING_PRI=C:\dev\tqtc-plugin-qtquickdesigner\studiodata\branding\ide_branding.pri

Building the Qt Design Studio Manual

Run qmake from Qt 5.14.0, or later with the path to the branding information as a parameter: <relative_path_to>\qmake.exe qtcreator.pro -r IDE_BRANDING_PRI=<absolute_path_to>\tqtc-plugin-qtquickdesigner\studiodata\branding\ide_branding.pri
Run make docs on Linux and macOS or nmake docs on Windows.

The docs are generated in qtcreator\doc\html\qtdesignstudio with the Qt Design Studio branding.