Sine Striker
2023-12-13 27604c5152cd9b768c31cbb1947e0138cea2c484
README.md
@@ -1,2 +1,46 @@
# 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.2  |      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
TODO
## Documentatons
+ Examples (TODO)
+ [Framelesshelper Related](docs/framelesshelper-related.md)
## License
QWindowKit is licensed under the Apache 2.0 License.