diff --git a/doc/qtcreator/src/howto/creator-telemetry.qdoc b/doc/qtcreator/src/howto/creator-telemetry.qdoc index 8cb24c64e6b..746c4b4efb6 100644 --- a/doc/qtcreator/src/howto/creator-telemetry.qdoc +++ b/doc/qtcreator/src/howto/creator-telemetry.qdoc @@ -148,7 +148,7 @@ /*! \page creator-crashpad.html \previouspage collecting-user-feedback.html - \nextpage studio-help.html + \nextpage studio-packaging.html \title Reporting Crashes diff --git a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc index acff67c5884..2cdeb3fc89b 100644 --- a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc +++ b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc @@ -32,8 +32,8 @@ /*! \page creator-vcs-git.html \if defined(qtdesignstudio) - \previouspage studio-projects.html - \nextpage studio-importing-designs.html + \previouspage studio-packaging.html + \nextpage quick-converting-ui-projects.html \else \previouspage creator-vcs-cvs.html \nextpage creator-vcs-mercurial.html diff --git a/doc/qtdesignstudio/images/studio-add-resources.png b/doc/qtdesignstudio/images/studio-add-resources.png new file mode 100644 index 00000000000..802d5b73a48 Binary files /dev/null and b/doc/qtdesignstudio/images/studio-add-resources.png differ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc new file mode 100644 index 00000000000..36e302415e4 --- /dev/null +++ b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! + \page studio-packaging.html + \previouspage creator-crashpad.html + \nextpage creator-vcs-git.html + + \title Packaging Applications + + When you are ready to deliver your application to users or upload it to + app stores, you can use \QDS to create suitable packages that contain all + the necessary files, such as fonts, images, components, and modules. + + \section1 Adding Resources to Packages + + \QDS supports the \e{Qt Resource System} (QRC), which is a + platform-independent mechanism for storing files in the application's + executable. This is useful if your application always needs a certain + set of files (icons, translation files, and so on) and you don't want + to run the risk of losing the files. + + To package your application, select \uicontrol Build > + \uicontrol {Generate QRC Resource File}. Then select the + files to package in the \uicontrol {Add Resources} dialog. + + \image studio-add-resources.png "Add Resources dialog" + + The dialog displays all the files listed in the project file (.qmlproject) + and located in the project folder. Files that are listed in the project + file are marked with bold text in the UI, to make it easy to identify the + differences between the project file and the resource collection file. + + When you select \uicontrol OK, \QDS creates a resource collection file + (.qrc) in the project folder. + + If you remove files from the project that you already added to the + resource collection file, you can recreate the resource collection + file to remove them also from there. + + \section1 Embedding Resources into Applications + + Alternatively, you can embedd the resources into your application by + selecting \uicontrol Build > \uicontrol {Generate RCC Resource File}. + Select the location for the .qmlrc file, and then select the files to + embedd in the \uicontrol {Add Resources} dialog. + + When you select \uicontrol OK, \QDS creates a resource collection file + (.qmlrc) in the location you selected. +*/ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 1d3fb757af9..9442cbfd6db 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -242,6 +242,7 @@ \li \l {Collecting User Feedback} \li \l {Reporting Crashes} \endlist + \li {Packaging Applications} \endlist \li \l{Developer Topics} (NEW) \list diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc index cdbbf2751ef..27bea4cf72f 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc @@ -100,6 +100,7 @@ \endlist \li \b {\l{Developer Topics}} (NEW) \list + \li \l{Packaging Applications} \li \l{Using Git} \li \l{Converting UI Projects to Applications} \li \l{Using External Tools}