From eda513356b8eb58b3069ddceb8c3dbc63c7fcdcd Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周日, 17 12月 2023 15:58:49 +0800
Subject: [PATCH] Update resources
---
README.md | 76 ++++++++++++++++++++++++++++++++++++-
1 files changed, 73 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 79ca919..e895b0f 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
| Component | Requirement | Detailed |
|:---------:|:-----------:|:------------------------------------:|
-| Qt | \>=5.15.2 | Core, Gui, Widgets, Quick |
+| Qt | \>=5.15 | Core, Gui, Widgets, Quick |
| Compiler | \>=C++17 | MSVC 2019, GCC, Clang |
| CMake | \>=3.17 | >=3.20 is recommended |
@@ -32,9 +32,79 @@
+ [qmsetup](https://github.com/stdware/qmsetup)
-## Quick Start
+## Integrate
+
+### Build & Install
+
+```sh
+cmake -B build \
+ -Dqmsetup_DIR=<dir> \ # Optional
+ -DCMAKE_INSTALL_PREFIX=/path/install \
+ -G "Ninja Multi-Config"
+
+cmake --build build --target install --config Debug
+cmake --build build --target install --config Release
+```
+
+You can also include this directory as a sub-project if you choose CMake as your build system.
+
+For other build systems, you need to install with CMake first and include the corresponding configuration files in your project.
+
+### Import
+
+#### CMake Project
+
+```cmake
+cmake -B build -DQWindowKit_DIR=/path/install/cmake/QWindowKit
+```
+```cmake
+find_package(QWindowKit REQUIRED)
+taraget_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
+taraget_link_libraries(quick_app PUBLIC QWindowKit::Quick)
+```
+
+#### QMake Project
+```cmake
+# WidgetsApp.pro
+include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
+
+# QuickApp.pro
+include("/path/install/share/QWindowKit/qmake/QWKQuick.pri")
+```
+
+#### Visual Studio Project
TODO
+
+## Quick Start
+
+### Initialization
+
+First of all, you're supposed to add the following code in your `main` function in a very early stage (MUST before the construction of any `Q(Gui|Core)Application` objects).
+
+```c++
+int main(int argc, char *argv[]) {
+#ifdef Q_OS_WINDOWS
+ QCoreApplication::setAttribute(Qt::AA_DontCreateNativeWidgetSiblings);
+#elif defined(Q_OS_MAC)
+# if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+ qputenv("QT_MAC_WANTS_LAYER", "1");
+# endif
+#endif
+}
+```
+
+### Qt Widgets Application
+
+TODO
+
+### Qt Quick Application
+
+TODO
+
+### Learn More
+
+See [examples](examples) for more demo use cases.
## Documentatons
@@ -43,4 +113,4 @@
## License
-QWindowKit is licensed under the Apache 2.0 License.
\ No newline at end of file
+QWindowKit is licensed under the [Apache 2.0 License](LICENSE).
\ No newline at end of file
--
Gitblit v1.9.1