From 59814f0ef77528995e2655247aecf2dfdf2f67d9 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周一, 18 12月 2023 21:56:48 +0800
Subject: [PATCH] Update README

---
 README.md |   76 ++++++++++++++++++++++++++------------
 1 files changed, 52 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 5b9b809..3e3a7aa 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,6 +39,7 @@
 
 ## Dependencies
 
++ Qt 5.15 or higher
 + [qmsetup](https://github.com/stdware/qmsetup)
 
 ## Integrate
@@ -46,7 +56,7 @@
 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.
+You can also include this directory as a subproject 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.
 
@@ -54,17 +64,17 @@
 
 #### CMake Project
 
-```cmake
+```sh
 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)
+target_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
+target_link_libraries(quick_app PUBLIC QWindowKit::Quick)
 ```
 
 #### QMake Project
-```qmake
+```cmake
 # WidgetsApp.pro
 include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
 
@@ -78,25 +88,43 @@
 
 ## Quick Start
 
-### Initialization
+### Qt Widgets Application
 
-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).
-
+First, setup `WidgetWindowAgent` for your QWidget instance. (Each widget needs its own agent.)
 ```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
+auto w = new MyWidget();
+auto agent = new WidgetWindowAgent(w);
+agent->setup(w);
+```
+
+You can also initialize the agent in the widget constructor.
+```c++
+MyWidget::MyWidget(QWidget *parent) {
+    // ...
+    auto agent = new WidgetWindowAgent(w);
+    agent->setup(w);
 }
 ```
 
-### Qt Widgets Application
+Then, construct your title bar widget, without which the window is lacking in basic interaction feature. You can use the [`WindowBar`](examples/shared/widgetframe/windowbar.h) provided by `WidgetFrame` in the examples as the container for your title bar components.
 
-TODO
+Let `WidgetWindowAgent` know which widget the title bar is.
+```c++
+agent->setTitleBarWidget(myTitleBar);
+```
+
+Set system button hints to let `WidgetWindowAgent` know the role of the widgets, which is important for the Snap Layout to work.
+```c++
+agent->setSystemButton(QWK::WindowAgent::Base::Maximize, maxButton);
+```
+
+Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events. 
+```c++
+agent->setHitTestVisible(myTitleBar->menuBar(), true);
+```
+Other region inside the title bar will be regarded as the draggable area for user to move the window.
+
+Check [`MainWindow`](examples/mainwindow/mainwindow.cpp#L108) example to get detailed information.
 
 ### Qt Quick Application
 
@@ -104,13 +132,13 @@
 
 ### Learn More
 
-See [examples](examples) for more demo use cases.
+See [examples](examples) for more demo use cases. The examples have no High DPI support.
 
-## Documentatons
+## Documentations
 
 + Examples (TODO)
-+ [Framelesshelper Related](docs/framelesshelper-related.md)
++ [FramelessHelper Related](docs/framelesshelper-related.md)
 
 ## 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