Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rectalogic committed Mar 6, 2024
1 parent abc3455 commit 305abad
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 14 deletions.
3 changes: 3 additions & 0 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ All notable changes to this project will be documented in this file.
`Unreleased`_
=============

Added
-----
- Add support for arm64 architecture on linux desktop (#766)

`v3.1.12`_ (2, Mar. 2024)
=========================
Expand Down
32 changes: 20 additions & 12 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ List available versions of Qt, targets, modules, and architectures.

.. describe:: host

linux, windows or mac
linux, linux_arm64, windows or mac

.. describe:: target

Expand Down Expand Up @@ -177,7 +177,7 @@ List source archives available for installation using the `install-src command`_

.. describe:: host

linux, windows or mac
linux, linux_arm64, windows or mac

.. describe:: Qt version

Expand Down Expand Up @@ -217,7 +217,7 @@ installation using the `install-doc command`_, with the ``--archives`` option.

.. describe:: host

linux, windows or mac
linux, linux_arm64, windows or mac

.. describe:: Qt version

Expand Down Expand Up @@ -262,7 +262,7 @@ installation using the `install-example command`_, with the ``--archives`` optio

.. describe:: host

linux, windows or mac
linux, linux_arm64, windows or mac

.. describe:: Qt version

Expand Down Expand Up @@ -300,7 +300,7 @@ List available tools

.. describe:: host

linux, windows or mac
linux, linux_arm64, windows or mac

.. describe:: target

Expand Down Expand Up @@ -502,7 +502,7 @@ There are various combinations to accept according to Qt version.
.. describe:: host
linux, windows or mac. The operating system on which the Qt development tools will run.
linux, linux_arm64, windows or mac. The operating system on which the Qt development tools will run.
.. describe:: target
Expand Down Expand Up @@ -533,7 +533,9 @@ There are various combinations to accept according to Qt version.
The compiler architecture for which you are developing. Options:
* gcc_64 for linux desktop
* gcc_64 or linux_gcc_64 for linux desktop
* linux_gcc_arm64 for linux_arm64 desktop
* clang_64 for mac desktop
Expand Down Expand Up @@ -587,7 +589,7 @@ Install Qt source code for the specified version and target.
.. describe:: host
linux, windows or mac
linux, linux_arm64, windows or mac
.. describe:: target
Expand Down Expand Up @@ -647,7 +649,7 @@ Install Qt documentation for the specified version and target.
.. describe:: host
linux, windows or mac
linux, linux_arm64, windows or mac
.. describe:: target
Expand Down Expand Up @@ -701,7 +703,7 @@ Install Qt examples for the specified version and target.
.. describe:: host
linux, windows or mac
linux, linux_arm64, windows or mac
.. describe:: target
Expand Down Expand Up @@ -753,7 +755,7 @@ Install tools like QtIFW, mingw, Cmake, Conan, and vcredist.
.. describe:: host
linux, windows or mac
linux, linux_arm64, windows or mac
.. describe:: target
Expand Down Expand Up @@ -802,8 +804,14 @@ Example: Installing the newest LTS version of Qt 5.12:
.. code-block:: console
pip install aqtinstall
sudo aqt install-qt linux desktop 5.12 win64_mingw73
sudo aqt install-qt linux desktop 5.12 gcc_64
Example: Installing the newest LTS version of Qt 6.7 for linux arm64:
.. code-block:: console
pip install aqtinstall
sudo aqt install-qt linux_arm64 desktop 6.7
Example: Installing Android (armv7) Qt 5.13.2:
Expand Down
10 changes: 8 additions & 2 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Some older operating systems may require you to specify Python version 3, like t

To use ``aqt`` to install Qt, you will need to tell ``aqt`` four things:

1. The host operating system (windows, mac, or linux)
1. The host operating system (windows, mac, linux, or linux_arm64)
2. The target SDK (desktop, android, ios, or winrt)
3. The version of Qt you would like to install
4. The target architecture
Expand Down Expand Up @@ -99,6 +99,12 @@ instead of an explicit version:
$ aqt install-qt windows desktop 6.2 win64_mingw81
As of Qt 6.7.0, arm64 architecture is now supported for linux desktop.
It is implemented using both a different host (``linux_arm64``) and architecture (``linux_gcc_arm64``).

.. code-block:: console
$ aqt install-qt linux_arm64 desktop 6.7.0 linux_gcc_arm64
External 7-zip extractor
------------------------
Expand Down Expand Up @@ -458,7 +464,7 @@ probably the compiler you want to install (see `long_modules explanation`_).
Now let's install ``mingw``, using the :ref:`aqt install-tool <tools installation command>` command.
This command receives four parameters:

1. The host operating system (windows, mac, or linux)
1. The host operating system (windows, mac, linux, or linux_arm64)
2. The target SDK (desktop, android, ios, or winrt)
3. The name of the tool (this is ``tools_mingw`` in our case)
4. (Optional) The tool variant name. We saw a list of these when we ran
Expand Down

0 comments on commit 305abad

Please sign in to comment.