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
---
src/core/contexts/cocoawindowcontext.mm | 5 ++++-
README.md | 26 ++++++++++++++++++++++++++
2 files changed, 30 insertions(+), 1 deletions(-)
diff --git a/README.md b/README.md
index 9b4d635..cef2f0f 100644
--- a/README.md
+++ b/README.md
@@ -34,8 +34,34 @@
## 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)
diff --git a/src/core/contexts/cocoawindowcontext.mm b/src/core/contexts/cocoawindowcontext.mm
index 67ca980..34fdcb2 100644
--- a/src/core/contexts/cocoawindowcontext.mm
+++ b/src/core/contexts/cocoawindowcontext.mm
@@ -6,7 +6,10 @@
#include <QtGui/QGuiApplication>
namespace QWK {
-
+ // ### FIXME FIXME FIXME
+ // ### FIXME: Tell the user to call in the documentation, instead of automatically
+ // calling it directly.
+ // ### FIXME FIXME FIXME
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
static const struct QWK_Hook {
QWK_Hook() {
--
Gitblit v1.9.1