From 1d128b98cb7d9f57b65b426b401c66f06f6e7d77 Mon Sep 17 00:00:00 2001
From: SineStriker <trueful@163.com>
Date: 周一, 18 12月 2023 21:33:41 +0800
Subject: [PATCH] Update README

---
 README.md |   66 ++++++++++++++++++++++++--------
 1 files changed, 49 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 5b9b809..7c720dd 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
@@ -64,7 +74,7 @@
 ```
 
 #### QMake Project
-```qmake
+```cmake
 # WidgetsApp.pro
 include("/path/install/share/QWindowKit/qmake/QWKWidgets.pri")
 
@@ -78,25 +88,47 @@
 
 ## 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 titlebar 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 titlebar components.
 
-TODO
+```c++
+auto titleLabel = new QLabel();
+auto menuBar = new QMenuBar();
+
+auto windowBar = new QWK::WindowBar();
+windowBar->setMenuBar(menuBar);
+windowBar->setTitleLabel(titleLabel);
+windowBar->setHostWidget(this);
+
+auto iconButton = new QPushButton("馃槃");
+auto minButton = new QPushButton("鈹�");
+auto maxButton = new QPushButton("鈻�");
+auto closeButton = new QPushButton("鉁�");
+agent->setSystemButton(QWK::WindowAgentBase::WindowIcon, iconButton);
+agent->setSystemButton(QWK::WindowAgentBase::Minimize, minButton);
+agent->setSystemButton(QWK::WindowAgentBase::Maximize, maxButton);
+agent->setSystemButton(QWK::WindowAgentBase::Close, closeButton);
+
+```
 
 ### Qt Quick Application
 
@@ -104,7 +136,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
 
@@ -113,4 +145,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