From f392d08bdf1deadd3965a5183546fbbe933c4e7d Mon Sep 17 00:00:00 2001 From: Gary Wang Date: Fri, 2 Aug 2019 14:52:16 +0800 Subject: [PATCH] doc: Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 768a637..cdf88c2 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This is a Qt wrapper library for Gio (or say it's a glib/glibmm wrapper mainly f - cmake `>= 3.12.4` - pkg-config (to find and use giomm module) - - Qt5Core `>=5.6.3` + - Qt5Core `>= 5.6.3` - Qt5Test (if you would like to build tests) - giomm-2.4 - doxygen (to build documentations) @@ -30,7 +30,9 @@ $ sudo make install It will installed to `/usr/local/lib` by default. You may also need to do a `sudo ldconfig /usr/local/lib` after install. -## Should I use? +## Questions and Answers + +### Should I use? @@ -38,6 +40,12 @@ Before this library release it's first stable tag (1.0.0) the answer is mostly * If you are writing a non-Qt application, please consider using [glibmm](https://gitlab.gnome.org/GNOME/glibmm). If you are writing Qt application and really wanna use this library, consider wait its API stable release or create a fork and start hacking! +### What about generate Qt binding using GObject Introspection + +As you can see `gio-qt` currently is a hand-crafted Qt/C++ bindings for GIO. Using [GObject Introspection (gir)](https://wiki.gnome.org/Projects/GObjectIntrospection) to generate code could be a really good idea but we currently doesn't have very enough time to look into it. + +It's definitely worth to look into `gir` to generate Qt binding and actually there was some cool guys working on this idea (see [GObject Consume](https://wiki.gnome.org/action/show/Projects/GObjectIntrospection/GObjectConsume)) and worth to check it out. Due to the project time limit so we are not going to use it currently, but we encourage you contirbute on that project if you are familiar to `gir`. + ## Documentation For Deepin there will be a `libgio-qt-doc` package, if you are building it manually with `BUILD_DOCS` option enabled, there will be a docs folder inside your build folder, and there will be a doxygen generated html folder and also a `gio-qt.qch` for QtCreator.