From 781a7d140cbc44381adf71f745bfa5b1786f7142 Mon Sep 17 00:00:00 2001
From: Sine Striker <trueful@163.com>
Date: 周日, 17 12月 2023 02:37:28 +0800
Subject: [PATCH] Update doc
---
README.md | 74 ++++++++++++++++++++++++++++++++++++-
1 files changed, 72 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 382ea9a..cef2f0f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,72 @@
-# 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.
+
+This project inherited most of [FramelessHelper](https://github.com/wangwenx190/framelesshelper)'s implementation, with a complete refactoring and upgrading of the architecture.
+
+## 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
+
++ [qmsetup](https://github.com/stdware/qmsetup)
+
+## Quick Start
+
+### Initialization
+
+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).
+
+```c++
+int main(int argc, char *argv[]) {
+#ifdef Q_OS_WINDOWS
+ qApp->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
+}
+```
+
+### Qt Widgets Application
+
+TODO
+
+### Qt Quick Application
+
+TODO
+
+### Learn More
+
+See [examples](examples) for more demo use cases.
+
+## Documentatons
+
++ Examples (TODO)
++ [Framelesshelper Related](docs/framelesshelper-related.md)
+
+## License
+
+QWindowKit is licensed under the [Apache 2.0 License](LICENSE).
\ No newline at end of file
--
Gitblit v1.9.1