mirror of
https://github.com/miurahr/aqtinstall.git
synced 2025-12-17 04:34:37 +03:00
README: make shorter and dense for v2.0
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
This commit is contained in:
Hiroshi Miura
227
README.rst
227
README.rst
@@ -62,23 +62,35 @@ For details see `Qt licensing`_ and `Licenses used in Qt5`_
|
||||
|
||||
.. _`Licenses used in Qt5`: https://doc.qt.io/qt-5/licenses-used-in-qt.html
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
- Minimum Python version: 3.6
|
||||
- Recommended Python version: 3.8, 3.9 (frequently tested on)
|
||||
- Minimum Python version:
|
||||
3.6
|
||||
- Recommended Python version:
|
||||
3.9 (frequently tested on)
|
||||
|
||||
- Dependent libraries: requests, py7zr
|
||||
- Dependencies:
|
||||
requests
|
||||
semantic_version
|
||||
patch
|
||||
py7zr
|
||||
texttable
|
||||
bs4
|
||||
dataclasses
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
There are two versions of documentation:
|
||||
|
||||
- Stable version (v1.2) : https://aqtinstall.readthedocs.io/en/stable/
|
||||
- Development version (v2.0b): https://aqtinstall.readthedocs.io/en/latest
|
||||
There is precise documentation with many examples.
|
||||
You are recommended to read *Getting started* section.
|
||||
|
||||
- Getting started: https://aqtinstall.readthedocs.io/en/latest/getting_started.html
|
||||
- Stable (v2.0.x): https://aqtinstall.readthedocs.io/en/stable
|
||||
- Latest: https://aqtinstall.readthedocs.io/en/latest
|
||||
|
||||
- Old (v1.2.5) : https://aqtinstall.readthedocs.io/en/v1.2.5/index.html
|
||||
|
||||
Install
|
||||
-------
|
||||
@@ -98,174 +110,23 @@ You are recommended to update pip before installing aqtinstall.
|
||||
Older pip does not handle it expectedly(see #230).
|
||||
|
||||
|
||||
Usage(as in v1.2.x)
|
||||
-------------------
|
||||
Example
|
||||
--------
|
||||
|
||||
General usage looks like this:
|
||||
When installing Qt SDK 6.2.0 for Windows.
|
||||
|
||||
::
|
||||
|
||||
aqt [-h][--help][-O | --outputdir <directory>][-b | --base <mirror url>][-E | --external <7zip command>] \
|
||||
install <qt-version> <host> <target> [<arch>] [-m all | -m [extra module] [extra module]...] [--internal]
|
||||
[--archives <archive>[ <archive>...]] [--timeout <timeout(sec)>]
|
||||
|
||||
You can also call with ``python -m aqt`` syntax as well as command script ``aqt``.
|
||||
|
||||
Many older Linux distributions symlink ``python`` to the older Python 2.7, which is incompatible with ``aqt``.
|
||||
If you are using such a system, please check your Python 3 version with ``python3 --version``,
|
||||
and run ``aqt`` using ``python3 -m aqt``.
|
||||
|
||||
* The Qt version is formatted like this: `5.11.3`
|
||||
* Host is one of: `linux`, `mac`, `windows`
|
||||
* Target is one of: `desktop`, `android`, `ios` (iOS only works with mac host)
|
||||
* For some platforms you also need to specify an arch:
|
||||
* For windows, choose one of:
|
||||
* `win64_msvc2019_64`, `win32_msvc2019`,
|
||||
* `win64_msvc2017_64`, `win32_msvc2017`,
|
||||
* `win64_msvc2015_64`, `win32_msvc2015`,
|
||||
* `win64_mingw81`, `win32_mingw81`,
|
||||
* `win64_mingw73`, `win32_mingw73`,
|
||||
* `win64_mingw53`, `win32_mingw53`,
|
||||
* `win64_msvc2019_winrt_x64`, `win64_msvc2019_winrt_x86`, `win64_msvc2019_winrt_armv7`
|
||||
* `win64_msvc2017_winrt_x64`, `win64_msvc2017_winrt_x86`, `win64_msvc2017_winrt_armv7`
|
||||
* For android and Qt 6 or Qt 5.13 and below, choose one of: `android_x86_64`, `android_arm64_v8a`, `android_x86`,
|
||||
`android_armv7`
|
||||
* You can specify external 7zip command path instead of built-in extractor.
|
||||
* When specifying `all` for extra modules option `-m` all extra modules are installed.
|
||||
|
||||
|
||||
Installing tool and utility (Experimental)
|
||||
------------------------------------------
|
||||
|
||||
You can install tools and utilities using following syntax;
|
||||
|
||||
::
|
||||
|
||||
aqt [-h][--help][-O | --outputdir <directory>][-b | --base <mirror url>][-E <7zip command>] \
|
||||
tool <host> <tool_name> <tool-version> <arch> [--timeout <timeout>]
|
||||
|
||||
* tool_name is one of `tools_ifw`, `tools_vcredist`, and `tools_openssl`.
|
||||
* arch is full qualified tool name such as `qt.tools.ifw.31` which values can be seen on Qt `archive_site`_
|
||||
This is a quite experimental feature, may not work and please use it with your understanding what you are doing.
|
||||
* It does not recognize 'installscript.qs'.
|
||||
When using tools which depends on a qt script, you should do something by yourself.
|
||||
|
||||
.. _`archive_site`: https://download.qt.io/online/qtsdkrepository/linux_x64/desktop/tools_ifw/
|
||||
|
||||
|
||||
Target directory
|
||||
----------------
|
||||
|
||||
aqt can take option '--outputdir' or '-O' that specify a target directory.
|
||||
|
||||
The Qt packages are installed under current directory as such `Qt/<ver>/gcc_64/`
|
||||
|
||||
If you want to install it in `C:\Qt` as same as standard gui installer default,
|
||||
run such as follows(on Windows):
|
||||
Check what options you can take by `list-qt` subcommand
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
cd c:\
|
||||
mkdir Qt
|
||||
py -m aqt install --outputdir c:\Qt 5.15.2 windows desktop win64_msvc2019_64
|
||||
aqt list-qt windows desktop --arch 6.2.0
|
||||
|
||||
|
||||
If you want to install it in `/opt/Qt` as same as standard gui installer default,
|
||||
run such as follows(on mac/linux):
|
||||
Then you may get candidates; `win64_mingw81 win64_msvc2019_64 win64_msvc2019_arm64t`
|
||||
When you decided to install Qt SDK version 6.2.0 for mingw v8.1 gcc.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
sudo mkdir /opt/Qt
|
||||
sudo python -m aqt install --outputdir /opt/Qt 5.15.2 linux desktop gcc_64
|
||||
|
||||
|
||||
Command examples
|
||||
----------------
|
||||
|
||||
Example: Installing Qt SDK 5.12.0 for Linux with QtCharts and QtNetworkAuth:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
pip install aqtinstall
|
||||
aqt install --outputdir /opt/Qt 5.12.0 linux desktop -m qtcharts qtnetworkauth
|
||||
|
||||
|
||||
Example: Installing Android (armv7) Qt 5.10.2:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt install 5.10.2 linux android android_armv7
|
||||
|
||||
|
||||
Example: Installing Android Qt 5.15.2:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt install 5.15.2 linux android android
|
||||
|
||||
|
||||
Example: Install examples, doc and source:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
py -m aqt examples 5.15.0 windows desktop -m qtcharts qtnetworkauth
|
||||
py -m aqt doc 5.15.0 windows desktop -m qtcharts qtnetworkauth
|
||||
py -m aqt src 5.15.0 windows desktop
|
||||
|
||||
|
||||
Example: Install Web Assembly for Qt5
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt install 5.15.0 linux desktop wasm_32
|
||||
|
||||
|
||||
Example: Install an Install FrameWork (IFW):
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt tool linux desktop tools_ifw
|
||||
|
||||
|
||||
Example: Install vcredist:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
py -m aqt tool windows desktop tools_vcredist
|
||||
.\Qt\Tools\vcredist\vcredist_msvc2019_x64.exe /norestart /q
|
||||
|
||||
|
||||
Example: Install MinGW on Windows
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
py -m aqt tool -O c:\Qt windows desktop tools_mingw qt.tools.win64_mingw810
|
||||
set PATH=C:\Qt\Tools\mingw810_64\bin
|
||||
|
||||
|
||||
Example: Install Qt6 for android
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt install -O qt 6.1.0 linux desktop
|
||||
aqt install -O qt 6.1.0 linux android android_armv7
|
||||
qt/6.1.0/android_armv7/bin/qmake -query
|
||||
|
||||
|
||||
Example: Install Qt6 for ios/mac
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt install -O qt 6.1.0 mac desktop
|
||||
aqt install -O qt 6.1.0 mac ios ios
|
||||
qt/6.1.0/ios/bin/qmake -query
|
||||
|
||||
|
||||
Example: Show help message
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
aqt help
|
||||
aqt install-qt windows desktop 6.2.0 win64_mingw81
|
||||
|
||||
|
||||
Environment Variables
|
||||
@@ -283,38 +144,6 @@ It is users task to set some environment variables to fit your platform such as
|
||||
|
||||
aqtinstall never do it for you because not to break multiple installation versions.
|
||||
|
||||
|
||||
|
||||
Supported CI platforms
|
||||
----------------------
|
||||
|
||||
There are no limitation for CI platform but currently it is tested on Azure Pipelines and Github actions.
|
||||
If you want to use it with Github actions, `install_qt`_ action will help you.
|
||||
If you want to use it with Azure Pipelines, blog article `Using Azure DevOps Pipelines with Qt`_ may be informative.
|
||||
|
||||
|
||||
(Advanced) Force dependency
|
||||
---------------------------
|
||||
|
||||
(Here is a note for advanced user who knows python/pip well.)
|
||||
|
||||
When you have a trouble on your (minor) platform to install aqtinstall's dependency,
|
||||
you can force dependencies and its versions (not recommended for ordinary use).
|
||||
You can run `pip` to install individual dependencies in manual and install aqtinstall with `--no-deps`.
|
||||
|
||||
Example:
|
||||
^^^^^^^^
|
||||
|
||||
Avoid installation of py7zr, python 7zip library, and force using external 7z command to extract archives.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
pip install -U pip
|
||||
pip install requests==2.25.1 semantic_version texttable
|
||||
pip install --no-deps aqtinstall
|
||||
python -m aqt --external /usr/local/bin/7z install 5.15.2 linux desktop
|
||||
|
||||
|
||||
Testimonies
|
||||
-----------
|
||||
|
||||
@@ -343,7 +172,7 @@ Media, slide, articles and discussions
|
||||
|
||||
* Qt Forum: `Automatic installation for Travis CI (or any other CI)`_
|
||||
|
||||
* Qt Form: `Qt silent, unattended install`_
|
||||
* Qt Forum: `Qt silent, unattended install`_
|
||||
|
||||
* Qt Study group presentation: `Another Qt CLI installer`_
|
||||
|
||||
|
||||
18
SECURITY.rst
18
SECURITY.rst
@@ -4,15 +4,15 @@ Security Policy
|
||||
Supported Versions
|
||||
------------------
|
||||
|
||||
+---------+--------------------+
|
||||
| Version | Status |
|
||||
+=========+====================+
|
||||
| 2.0.x | Development |
|
||||
+---------+--------------------+
|
||||
| 1.2.x | Stable version |
|
||||
+---------+--------------------+
|
||||
| < 1.2 | not supported |
|
||||
+---------+--------------------+
|
||||
+---------+---------------------+
|
||||
| Version | Status |
|
||||
+=========+=====================+
|
||||
| 2.0.x | Stable version |
|
||||
+---------+---------------------+
|
||||
| 1.2.5+ | Security fixes only |
|
||||
+---------+---------------------+
|
||||
| < 1.2 | not supported |
|
||||
+---------+---------------------+
|
||||
|
||||
Reporting a Vulnerability
|
||||
-------------------------
|
||||
|
||||
Reference in New Issue
Block a user