aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTor Arne VestbΓΈ <tor.arne.vestbo@qt.io>2021-05-27 13:48:50 +0200
committerTor Arne VestbΓΈ <tor.arne.vestbo@qt.io>2021-06-07 16:15:41 +0200
commitdb1ceebe72b806375c6cf4e4cafd8e8f81ad9dd9 (patch)
treeb0eb01720e15806cb145590b941c13cc786fd2b7 /README.md
parentb61f0209c4ea9f92deaaa1828223f35c7fdb80e4 (diff)
Remove module and add note about current status in Qt 6HEADdev
See QTBUG-89564 for overview and replacements for the APIs. The Qt 6 porting guide will be updated to explain how to move away from the removed module. The 5.15 branch is still available for anyone wanting to look at or incorporate code in their own projects. Task-number: QTBUG-89564 Change-Id: I1f0afc5ba3e694623fbbb51f10967321e81f32c9 Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ce1c60f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# QtWinExtras
+
+**The QtWinExtras module has been deprecated and is no longer part of Qt.**
+
+The functionality of the module has been incorporated into other parts of Qt, or in some cases removed due to being obsole or better suited as cross platform APIs.
+
+For more details, see [QTBUG-89564](https://bugreports.qt.io/browse/QTBUG-89564) in the Qt issue tracker.
+
+## Porting away from QtWinExtras
+
+To learn more about how to port from QtWinExtras to alternative APIs please visit the [Qt 6 porting guide](https://doc.qt.io/qt-6/portingguide.html).
+
+## Working on Qt 5
+
+To work on patches for the Qt 5 series, check out a local branch of the relevant Qt version, e.g.:
+
+```bash
+$ git checkout 5.15
+Branch '5.15' set up to track remote branch '5.15' from 'origin' by rebasing.
+Switched to a new branch '5.15'
+```
+
+## Going back in time
+
+To inspect the code in the `dev` branch prior to its removal, follow these steps:
+
+```bash
+$ git checkout -b my-dev dev~1
+Switched to a new branch 'my-dev'
+```