diff --git a/doc/config/qtdoc.qdocconf b/doc/config/qtdoc.qdocconf index ff5407124..6df6e2aa5 100644 --- a/doc/config/qtdoc.qdocconf +++ b/doc/config/qtdoc.qdocconf @@ -83,6 +83,9 @@ manifestmeta.highlighted.names = "QtDoc/Coffee Machine Example" \ "QtDoc/Qt Quick Demo - Same Game" \ "QtDoc/Qt Quick Demo - Calqlatr" +# Include 'Qt for Education' pages +include(../edu/config/qtforeducation.qdocconf) + # Fail the documentation build if there are more warnings than the limit warninglimit = 0 diff --git a/doc/edu/config/qtforeducation.qdocconf b/doc/edu/config/qtforeducation.qdocconf new file mode 100644 index 000000000..dfdca1aa7 --- /dev/null +++ b/doc/edu/config/qtforeducation.qdocconf @@ -0,0 +1,8 @@ +sourcedirs += \ + ../src + +imagedirs += \ + ../images + +navigation.toctitles += "Qt for Education" +navigation.toctitles.inclusive = true diff --git a/doc/edu/images/qt-edu-apply.png b/doc/edu/images/qt-edu-apply.png new file mode 100644 index 000000000..8acc64ec9 Binary files /dev/null and b/doc/edu/images/qt-edu-apply.png differ diff --git a/doc/edu/images/qt-edu-browse-qbsp.png b/doc/edu/images/qt-edu-browse-qbsp.png new file mode 100644 index 000000000..4948d9e77 Binary files /dev/null and b/doc/edu/images/qt-edu-browse-qbsp.png differ diff --git a/doc/edu/images/qt-edu-contribute.png b/doc/edu/images/qt-edu-contribute.png new file mode 100644 index 000000000..071f28d92 Binary files /dev/null and b/doc/edu/images/qt-edu-contribute.png differ diff --git a/doc/edu/images/qt-edu-creator-open.png b/doc/edu/images/qt-edu-creator-open.png new file mode 100644 index 000000000..f065515b7 Binary files /dev/null and b/doc/edu/images/qt-edu-creator-open.png differ diff --git a/doc/edu/images/qt-edu-creator-welcome.png b/doc/edu/images/qt-edu-creator-welcome.png new file mode 100644 index 000000000..babf5a18f Binary files /dev/null and b/doc/edu/images/qt-edu-creator-welcome.png differ diff --git a/doc/edu/images/qt-edu-custominstallation.png b/doc/edu/images/qt-edu-custominstallation.png new file mode 100644 index 000000000..a3f2fd1ee Binary files /dev/null and b/doc/edu/images/qt-edu-custominstallation.png differ diff --git a/doc/edu/images/qt-edu-design-studio-open.png b/doc/edu/images/qt-edu-design-studio-open.png new file mode 100644 index 000000000..fbe90d7fe Binary files /dev/null and b/doc/edu/images/qt-edu-design-studio-open.png differ diff --git a/doc/edu/images/qt-edu-design-studio-welcome.png b/doc/edu/images/qt-edu-design-studio-welcome.png new file mode 100644 index 000000000..5b939b1c5 Binary files /dev/null and b/doc/edu/images/qt-edu-design-studio-welcome.png differ diff --git a/doc/edu/images/qt-edu-download.png b/doc/edu/images/qt-edu-download.png new file mode 100644 index 000000000..f8e890ba4 Binary files /dev/null and b/doc/edu/images/qt-edu-download.png differ diff --git a/doc/edu/images/qt-edu-install-design-studio.png b/doc/edu/images/qt-edu-install-design-studio.png new file mode 100644 index 000000000..b7faa62fe Binary files /dev/null and b/doc/edu/images/qt-edu-install-design-studio.png differ diff --git a/doc/edu/images/qt-edu-install-finish-design-studio.png b/doc/edu/images/qt-edu-install-finish-design-studio.png new file mode 100644 index 000000000..22afba64b Binary files /dev/null and b/doc/edu/images/qt-edu-install-finish-design-studio.png differ diff --git a/doc/edu/images/qt-edu-install-finish-qt.png b/doc/edu/images/qt-edu-install-finish-qt.png new file mode 100644 index 000000000..39d7f23dc Binary files /dev/null and b/doc/edu/images/qt-edu-install-finish-qt.png differ diff --git a/doc/edu/images/qt-edu-install-qt.png b/doc/edu/images/qt-edu-install-qt.png new file mode 100644 index 000000000..38dc0353b Binary files /dev/null and b/doc/edu/images/qt-edu-install-qt.png differ diff --git a/doc/edu/images/qt-edu-install-xcode.png b/doc/edu/images/qt-edu-install-xcode.png new file mode 100644 index 000000000..d2525ff6f Binary files /dev/null and b/doc/edu/images/qt-edu-install-xcode.png differ diff --git a/doc/edu/images/qt-edu-license-agreement.png b/doc/edu/images/qt-edu-license-agreement.png new file mode 100644 index 000000000..f14adbf42 Binary files /dev/null and b/doc/edu/images/qt-edu-license-agreement.png differ diff --git a/doc/edu/images/qt-edu-login.png b/doc/edu/images/qt-edu-login.png new file mode 100644 index 000000000..51c318883 Binary files /dev/null and b/doc/edu/images/qt-edu-login.png differ diff --git a/doc/edu/images/qt-edu-maintenancetool.png b/doc/edu/images/qt-edu-maintenancetool.png new file mode 100644 index 000000000..df9545834 Binary files /dev/null and b/doc/edu/images/qt-edu-maintenancetool.png differ diff --git a/doc/edu/images/qt-edu-password.png b/doc/edu/images/qt-edu-password.png new file mode 100644 index 000000000..1206bf928 Binary files /dev/null and b/doc/edu/images/qt-edu-password.png differ diff --git a/doc/edu/images/qt-edu-qbsp-download.png b/doc/edu/images/qt-edu-qbsp-download.png new file mode 100644 index 000000000..5a44619b1 Binary files /dev/null and b/doc/edu/images/qt-edu-qbsp-download.png differ diff --git a/doc/edu/images/qt-edu-qbsp.png b/doc/edu/images/qt-edu-qbsp.png new file mode 100644 index 000000000..a69deeb36 Binary files /dev/null and b/doc/edu/images/qt-edu-qbsp.png differ diff --git a/doc/edu/src/external-resources.qdoc b/doc/edu/src/external-resources.qdoc new file mode 100644 index 000000000..d6823c7f5 --- /dev/null +++ b/doc/edu/src/external-resources.qdoc @@ -0,0 +1,12 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \externalpage https://qt.io/qt-educational-license + \title Qt Educational License +*/ + +/*! + \externalpage https://doc.qt.io/qtcreator/creator-developing-b2qt.html + \title Qt Creator: Connecting Boot2Qt Devices +*/ diff --git a/doc/edu/src/qt-edu-for-designers.qdoc b/doc/edu/src/qt-edu-for-designers.qdoc new file mode 100644 index 000000000..0876b81c7 --- /dev/null +++ b/doc/edu/src/qt-edu-for-designers.qdoc @@ -0,0 +1,55 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qt-edu-for-designers.html + \title Qt Edu for Designers + +//! [intro] + \e {Qt Edu for Designers} package contains \l {Qt Design Studio Manual} + {Qt Design Studio Enterprise}, allowing you to import your designs from + design tools such as \e Figma, \e Sketch, or \e {Adobe XD}, and develop + them further into functioning user interfaces on your target devices. +//! [intro] + + These instructions walk you through the installation of the Qt Edu for + Designers package. + + \include qt-edu-steps.qdocinc {qt-edu-common-steps} {Qt Design Studio} + + \image qt-edu-install-design-studio.png + + With \e {Qt Edu for Designers} license, you get access to Qt Design + Studio. Select the \uicontrol {Design Tools} shortcut to install the + latest version of Qt Design Studio Enterprise. + + Select \uicontrol {Next}. + + \include qt-edu-steps.qdocinc qt-edu-license-agreement + + \section1 9. Finish the installation + + Select \uicontrol {Install} to start the installation process. + + Once installation is complete, you'll see the following screen: + + \image qt-edu-install-finish-design-studio.png + + Select \uicontrol {Finish} to exit the installer. + + \section1 10. Open Qt Design Studio + + Go to the installation folder to see all tools that were installed + on your computer. Qt Design Studio is located under its own folder: + + \image qt-edu-design-studio-open.png + + Run the \uicontrol {Qt Design Studio} application: + + \image qt-edu-design-studio-welcome.png + + \b {Now you're ready to start creating user interfaces with Qt Design + Studio!} + + Start learning at \l {https://resources.qt.io/learning-hub}{resources.qt.io/learning-hub}. +*/ diff --git a/doc/edu/src/qt-edu-for-developers.qdoc b/doc/edu/src/qt-edu-for-developers.qdoc new file mode 100644 index 000000000..d48dbbe04 --- /dev/null +++ b/doc/edu/src/qt-edu-for-developers.qdoc @@ -0,0 +1,56 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qt-edu-for-developers.html + \title Qt Edu for Developers + +//! [intro] + \e {Qt Edu for Developers} gives you access to developing with Qt’s full + C++ and QML frameworks, as well as its Python bindings. Developing on + embedded systems is possible with Raspberry Pi as the target platform. + This package also includes \l {Qt Design Studio Manual}{Qt Design Studio} + for designing user interfaces. +//! [intro] + + These instructions walk you through the installation of the Qt Edu for + Developers package. + + \include qt-edu-steps.qdocinc {qt-edu-common-steps} {Qt} + + \image qt-edu-install-qt.png + + If you are new to Qt, we recommend selecting the latest available version + of \uicontrol {Qt for desktop development}. This installs everything you + need for developing desktop applications with Qt. The installation may + always be modified later with the \e {maintenance tool}, located in Qt's + installation folder. + + Select \uicontrol {Next}. + + \include qt-edu-steps.qdocinc qt-edu-license-agreement + + \section1 9. Finish the installation + + Select \uicontrol {Install} to start the installation process. + + Once installation is complete, you'll see the following screen: + + \image qt-edu-install-finish-qt.png + + Select \uicontrol {Finish} to exit the installer. + + \section1 10. Open Qt Creator + + By default, \e {Qt Creator} opens automatically after closing the installer. + + \image qt-edu-creator-welcome.png + + You can also find it in Qt's installation folder: + + \image qt-edu-creator-open.png + + \b {Now you're ready to start developing applications with Qt!} + + Start learning at \l {https://resources.qt.io/learning-hub}{resources.qt.io/learning-hub}. +*/ diff --git a/doc/edu/src/qt-edu-raspberry-pi.qdoc b/doc/edu/src/qt-edu-raspberry-pi.qdoc new file mode 100644 index 000000000..e12064e26 --- /dev/null +++ b/doc/edu/src/qt-edu-raspberry-pi.qdoc @@ -0,0 +1,65 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qt-edu-raspberry-pi.html + \title Developing on Raspberry Pi + + With \l {Qt Edu for Developers} package, you can also develop for embedded + devices with Raspberry Pi as target hardware. This is done by adding a + \e {Qt Board Support Package} (QBSP) to your existing Qt installation, and + flashing an SD card used by Raspberry Pi with a \e {Boot to Qt} system + image. + + \note Windows and Linux are supported as development hosts, but \macos is + not supported. + + First, complete the \l {Qt Edu for Developers} installation steps before + continuing. + + \section1 1. Download QBSP + + Log in to your \l {https://login.qt.io/login}{Qt Account}. Go to the + \uicontrol Downloads section and select \e {Qt for Device Creation QBSP + for the EDU license} from the drop-down menu in the \uicontrol {Product} + field. + + \image qt-edu-qbsp.png + + Download the correct version of the \e {.qbsp} file for your development + host (Windows or Linux). + + \image qt-edu-qbsp-download.png + + \section1 2. Run the maintenance tool + + Go to Qt's installation folder, and run \uicontrol {MaintenanceTool}. + + \image qt-edu-maintenancetool.png + + Maintenance tool allows you to modify your existing Qt installation. + Navigate to \uicontrol {Custom installation} and select + \uicontrol {Next}. + + \image qt-edu-custominstallation.png + + Select \uicontrol {Browse QBSP files}. In the file dialog window, locate + and select the \c {.qbsp} file you downloaded from your Qt Account. + + \image qt-edu-browse-qbsp.png + + After this, the list of available components is updated. Under + \uicontrol {Boot to Qt Software Stack}, select \uicontrol {Raspberry Pi} + and then \uicontrol {Next}. This will install the Boot to Qt system image + and toolchain for Raspberry Pi. + + \section1 3. Open Qt Creator + + To complete the setup, the Boot to Qt system image needs to be flashed to + an SD card used as the boot drive for Raspberry Pi. In addition, Qt Creator + needs to be configured for connecting to the device running the Boot to Qt + software stack, using either a wired or wireless network connection. + + These steps are performed in Qt Creator, see + \l {Qt Creator: Connecting Boot2Qt Devices} for details. +*/ diff --git a/doc/edu/src/qt-edu-steps.qdocinc b/doc/edu/src/qt-edu-steps.qdocinc new file mode 100644 index 000000000..4613e2c44 --- /dev/null +++ b/doc/edu/src/qt-edu-steps.qdocinc @@ -0,0 +1,112 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + +//! {qt-edu-common-steps] + \section1 1. Apply for Qt Educational license + + Start by filling out the form available \l {Qt Educational License}{here}. + + \note To be eligible for a license, use an email address from an educational institution. + + \image qt-edu-apply.png + + \section2 Create a password + + After submitting the form, create a password for your \e {Qt Account}. Qt Account is where + you'll find details about your license, and it's created automatically for you after setting + a password. + + \note If you already have an account associated with an educational email address and you are + renewing the license, this step is skipped. + + \image qt-edu-password.png + + You can find more information about Qt Account \l {Information about Qt Account}{here}. + + \section1 2. Verify email address + + After setting up the Qt Account, verify your email address. Check your inbox for a message + containing a verification link. + + \section1 3. Download the online installer + + The verification link will automatically redirect you to a page for downloading the installer. + You can also find it \l {https://www.qt.io/download-qt-installer}{here}. + + \image qt-edu-download.png + + The page detects your operating system automatically and recommends a version to download. + Alternatively, you can click on \uicontrol {View other options} and select the correct version + of the online installer, then select \uicontrol {Download}. + + \section1 4. Run the installer + + Once the download completes, go to your download folder and run the installer. + + On Linux, you'll need to set execution permission for the installer binary. + + On \macos, the online installer is a \e {.dmg} file that contains the installer application. + Double-click on the installer icon to run it. + + \section1 5. Log in to Qt Account + + The installer asks you to log in to your Qt Account. Fill in the email address and the + password you created in step 1. + + \image qt-edu-login.png + + Select \uicontrol {Next}. + + \section2 Notes about build environment + + On \macos, you may see the following pop-up: + + \image qt-edu-install-xcode.png + + Developing on \macos requires Xcode to be installed on the system. + For more information, see \l {Qt for \macos#Build Environment} + {Qt for \macos - Build environment}. + + \b {See also} \l {Qt for Windows} and \l {Qt for Linux/X11}. + + \section1 6. Contribute to Qt development + + On the next step, the installer asks you to contribute to Qt development by + tracking usage data. + + \image qt-edu-contribute.png + + Select the preferred option and then \uicontrol {Next}. + + \section1 7. Select installation folder + + Select the directory where you want to install \1. + + \note \b {Avoid whitespace in the installation path} as this may lead to problems + later. + +//! {qt-edu-common-steps] + +//! {qt-edu-license-agreement] + + \section1 8. License agreements + + Before continuing, you need to accept the license agreements. Note that + \b {educational licenses are for learning purposes only}, as detailed under + \e {Appendix 5} of the Qt license agreement. + + If you want to create a commercial product, you need to buy a commercial + license or use an open-source license provided you can comply with the terms + and conditions of the open-source license(s). + + For more information, see \l {Qt Licensing}. + + \image qt-edu-license-agreement.png + + After reviewing the agreements, select the checkbox and continue with + \uicontrol {Next}. + +//! {qt-edu-license-agreement] +*/ diff --git a/doc/edu/src/qt-for-education.qdoc b/doc/edu/src/qt-for-education.qdoc new file mode 100644 index 000000000..fce95c443 --- /dev/null +++ b/doc/edu/src/qt-for-education.qdoc @@ -0,0 +1,62 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qt-for-education.html + \title Qt for Education + + Welcome to learning Qt! + + \e {Qt for Education} (Qt Edu) is a special licensing package for learning + purposes. You can find more information about educational licensing + \l {Qt Educational License}{here}. + + These instructions walk you through the installation of the different + Qt Edu packages, as well as applying for the educational license. + + \list + \li \l {Qt Edu for Designers} - for those interested in creating + user interfaces and functional user experiences + \li \l {Qt Edu for Developers} - for those interested in developing + Qt applications + \list + \li \l {Developing on Raspberry Pi} + \endlist + \li \l {Qt Edu resources} + \endlist + + \include qt-edu-for-designers.qdoc intro + + \include qt-edu-for-developers.qdoc intro +*/ + +/*! + \page qt-edu-resources.html + \title Qt Edu resources + + \section1 Information about Qt Account + + \c {Qt Account} is where you'll find details about your license, its + expiration date, and have access to additional downloads and support + services. + + An account is created automatically for you when you fill in the + \l {Qt Educational License} request form and create a password. Upon + renewal, the new license is linked to your existing Qt Account. + + You can log in to your Qt Account at \l {https://login.qt.io/}{login.qt.io}. + + If you have questions about your account, you can contact + \l {mailto://qtaccount@qt.io}{qtaccount@qt.io} or open a support ticket in + the account portal. + + \section1 Useful links + + \list + \li \l {https://www.qt.io/qt-educational-license} + {Frequently asked questions} about the Qt Educational License. + \li \l {https://forum.qt.io/category/19/qt-in-education}{Qt in Education} + in Qt Forum + \li \l {https://resources.qt.io/learning-hub}{Qt learning materials} + \endlist +*/ diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc index 23b03e4cd..868959bb9 100644 --- a/doc/src/getting-started/gettingstarted.qdoc +++ b/doc/src/getting-started/gettingstarted.qdoc @@ -21,6 +21,8 @@ \li \l {Solutions for UI Design} \li \l {Tools for Qt Quick UIs} \li \l {Install Qt Design Studio} + \li \l {Qt for Education} + {Install Qt Design Studio with Educational License} \li \l {Tools for Qt Widget-Based UIs} \li \l {Get and Install Qt} \li \l {Supported Platforms} @@ -31,6 +33,8 @@ \list \li \l {Solutions for Application Development} \li \l {Get and Install Qt} + \li \l {Qt for Education} + {Install Qt with Educational License} \li \l {Supported Platforms} \li \l {Create Your First Applications} \li \l {Explore Qt} diff --git a/doc/src/legal/licenses.qdoc b/doc/src/legal/licenses.qdoc index a59b7de79..6d846eed9 100644 --- a/doc/src/legal/licenses.qdoc +++ b/doc/src/legal/licenses.qdoc @@ -43,6 +43,9 @@ \e {Qt examples} are available under commercial licenses from The Qt Company, and under a \l{License of Qt examples}{BSD-3-clause} license. + \l {Qt Educational License}{Educational licenses} are available for students + and educators in qualified educational institutions or universities. + See \l{http://qt.io/licensing/} for an overview of Qt licensing. \section1 Purchasing and Sales Information