From 6500aae0d32383a988aff9fb680d58a851012a14 Mon Sep 17 00:00:00 2001
From: Zhao Yuhang <2546789017@qq.com>
Date: 周一, 18 12月 2023 20:59:09 +0800
Subject: [PATCH] finish quick demo

---
 README.md |   64 +++++++++++++++++++++++++++++--
 1 files changed, 59 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index cef2f0f..760f6f0 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
 # QWindowKit
 
-Cross-platform window customization framework for Qt Widgets and Qt Quick.
+Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.
 
-This project inherited most of [FramelessHelper](https://github.com/wangwenx190/framelesshelper)'s implementation, with a complete refactoring and upgrading of the architecture.
+This project inherited most of [wangwenx190 FramelessHelper](https://github.com/wangwenx190/framelesshelper) implementation, with a complete refactoring and upgrading of the architecture.
+
+## TODO
+
++ Fix 5.15 window unsupported behavior
++ Fix window 10 top border color in dark background
++ Fix `isFixedSize` code
++ Support customized system button area on Mac
++ Make Linux system move/resize more robust
++ Fix unhandled WinIdChange when adding a QWebEngineView as sub-widget (Win32 and Qt fixed)
 
 ## Supported Platforms
 
@@ -30,7 +39,52 @@
 
 ## Dependencies
 
++ Qt 5.15 or higher
 + [qmsetup](https://github.com/stdware/qmsetup)
+
+## 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
 
@@ -41,7 +95,7 @@
 ```c++
 int main(int argc, char *argv[]) {
 #ifdef Q_OS_WINDOWS
-    qApp->setAttribute(Qt::AA_DontCreateNativeWidgetSiblings);
+    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");
@@ -60,7 +114,7 @@
 
 ### Learn More
 
-See [examples](examples) for more demo use cases.
+See [examples](examples) for more demo use cases. The examples has no High DPI support.
 
 ## Documentatons
 
@@ -69,4 +123,4 @@
 
 ## License
 
-QWindowKit is licensed under the [Apache 2.0 License](LICENSE).
\ No newline at end of file
+QWindowKit is licensed under the Apache 2.0 License.
\ No newline at end of file

--
Gitblit v1.9.1