summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTor Arne Vestbø <torarnv@gmail.com>2021-06-07 15:58:23 +0200
committerTor Arne Vestbø <tor.arne.vestbo@qt.io>2021-06-07 16:23:21 +0200
commit694a3b095541389641d1da1f74732eac6a8c2a1a (patch)
tree7842f94899bbc3e3e463c05c140a12bd9e731009
parent6037ece5e4c0d290ae4ebf75c0d9bce0de55ed85 (diff)
downloadqtx11extras-dev.tar.gz
Flesh out READMEHEADdev
Change-Id: I73a2fd28f2769e3160942ae8ee2057abb23cb98a Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
-rw-r--r--README1
-rw-r--r--README.md30
2 files changed, 30 insertions, 1 deletions
diff --git a/README b/README
deleted file mode 100644
index c3d5c91..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-The QtX11Extras module no longer exists in Qt 6 (see QTBUG-83251).
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37f9998
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# QtX11Extras
+
+**The QtX11Extras 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 obsolete or better suited as cross platform APIs.
+
+For more details, see [QTBUG-93633](https://bugreports.qt.io/browse/QTBUG-93633) in the Qt issue tracker.
+
+## Porting away from QtX11Extras
+
+To learn more about how to port from QtX11Extras 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 0e67fb41c
+Switched to a new branch 'my-dev'
+```