Update README

Sine Striker

2023-12-18 59814f0ef77528995e2655247aecf2dfdf2f67d9

 README.md

@@ -56,7 +56,7 @@
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.
You can also include this directory as a subproject 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.

@@ -64,13 +64,13 @@

#### CMake Project

```cmake
```sh
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)
target_link_libraries(widgets_app PUBLIC QWindowKit::Widgets)
target_link_libraries(quick_app PUBLIC QWindowKit::Quick)
```

#### QMake Project
@@ -88,25 +88,43 @@

## 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 title bar 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 title bar components.

TODO
Let `WidgetWindowAgent` know which widget the title bar is.
```c++
agent->setTitleBarWidget(myTitleBar);
```

Set system button hints to let `WidgetWindowAgent` know the role of the widgets, which is important for the Snap Layout to work.
```c++
agent->setSystemButton(QWK::WindowAgent::Base::Maximize, maxButton);
```

Set hit-test visible hint to let `WidgetWindowAgent` know the widgets that desire to receive mouse events. 
```c++
agent->setHitTestVisible(myTitleBar->menuBar(), true);
```
Other region inside the title bar will be regarded as the draggable area for user to move the window.

Check [`MainWindow`](examples/mainwindow/mainwindow.cpp#L108) example to get detailed information.

### Qt Quick Application

@@ -114,12 +132,12 @@

### Learn More

See [examples](examples) for more demo use cases. The examples has no High DPI support.
See [examples](examples) for more demo use cases. The examples have no High DPI support.

## Documentatons
## Documentations

+ Examples (TODO)
+ [Framelesshelper Related](docs/framelesshelper-related.md)
+ [FramelessHelper Related](docs/framelesshelper-related.md)

## License