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 |  150 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 148 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 382ea9a..7c720dd 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,148 @@
-# qwindowkit
-Cross-platform window customization framework for Qt Widgets and Qt Quick. Supports Windows, Linux and macOS.
+# QWindowKit
+
+Cross-platform window customization framework for Qt Widgets and Qt Quick. Support Windows, macOS, Linux.
+
+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
+
++ Microsoft Windows (Vista ~ 11)
++ Apple Mac OSX (11+)
++ GNU/Linux (Tested on Ubuntu)
+
+## Requirements
+
+| Component | Requirement |               Detailed               |
+|:---------:|:-----------:|:------------------------------------:|
+|    Qt     |   \>=5.15   |      Core, Gui, Widgets, Quick       |
+| Compiler  |  \>=C++17   |        MSVC 2019, GCC, Clang         |
+|   CMake   |   \>=3.17   |        >=3.20 is recommended         |
+
+### Tested Compilers
+
++ Windows
+  + MSVC: 2019, 2022
+  + MinGW: 13.2.0
++ MacOSX
+  + Clang 14.0.3
++ Ubuntu
+  + GCC: 9.4.0
+
+## 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
+
+### Qt Widgets Application
+
+First, setup `WidgetWindowAgent` for your QWidget instance. (Each widget needs its own agent.)
+
+```c++
+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);
+}
+```
+
+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.
+
+```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
+
+TODO
+
+### Learn More
+
+See [examples](examples) for more demo use cases. The examples has no High DPI support.
+
+## Documentatons
+
++ Examples (TODO)
++ [Framelesshelper Related](docs/framelesshelper-related.md)
+
+## License
+
+QWindowKit is licensed under the Apache 2.0 License.
\ No newline at end of file

--
Gitblit v1.9.1