summaryrefslogtreecommitdiffstats
path: root/util/cmake/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/cmake/README.md')
-rw-r--r--util/cmake/README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/util/cmake/README.md b/util/cmake/README.md
index 256e481680..0d80fbcdce 100644
--- a/util/cmake/README.md
+++ b/util/cmake/README.md
@@ -2,6 +2,9 @@
This directory holds scripts to help the porting process from `qmake` to `cmake` for Qt6.
+If you're looking to port your own Qt-based project from `qmake` to `cmake`, please use
+[qmake2cmake](https://wiki.qt.io/Qmake2cmake).
+
# Requirements
* [Python 3.7](https://www.python.org/downloads/),
@@ -36,25 +39,19 @@ python3.7 -m pip install -r requirements.txt
# Contributing to the scripts
-You can verify if the styling of a script complaint with PEP8, with a couple of exceptions:
+You can verify if the styling of a script is compliant with PEP8, with a couple of exceptions:
Install [flake8](http://flake8.pycqa.org/en/latest/) (`pip install flake8`) and run it
-on the script you want to test:
+on all python source files:
```
-flake8 <file>.py --ignore=E501,E266,W503
+make flake8
```
-* `E501`: Line too long (82>79 characters),
-* `E266`: Too many leading '#' for block comment,
-* `W503`: Line break occurred before a binary operator)
-
You can also modify the file with an automatic formatter,
like [black](https://black.readthedocs.io/en/stable/) (`pip install black`),
and execute it:
```
-black -l 100 <file>.py
+make format
```
-
-Using Qt's maximum line length, 100.