From e18723d66cf470720c29a9d2848150ea1cbe5450 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 摹曛, 14 12月 2023 04:49:35 +0800
Subject: [PATCH] Add example resources

---
 README.md |   22 ++++++++++++++++++++--
 1 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b22601e..79ca919 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 Cross-platform window customization framework for Qt Widgets and Qt Quick.
 
-The next generation of [FramelessHelper](https://github.com/wangwenx190/framelesshelper).
+This project inherited most of [FramelessHelper](https://github.com/wangwenx190/framelesshelper)'s implementation, with a complete refactoring and upgrading of the architecture.
 
 ## Supported Platforms
 
@@ -18,11 +18,29 @@
 | 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
 
 + [qmsetup](https://github.com/stdware/qmsetup)
 
+## Quick Start
+
+TODO
+
+## Documentatons
+
++ Examples (TODO)
++ [Framelesshelper Related](docs/framelesshelper-related.md)
 
 ## License
 
-QWindowKit is licensed under the MIT 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