mirrors/gio-qt
1
0
Fork 1
mirror of https://github.com/linuxdeepin/gio-qt.git synced 2024-12-26 15:06:08 +01:00
Code Issues Projects Releases Packages Wiki Activity

doc: Update README.md

Browse source
This commit is contained in:
Gary Wang 2019-08-02 14:52:16 +08:00
parent 7dc310c8a8
commit f392d08bdf
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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` - cmake `>= 3.12.4`
- pkg-config (to find and use giomm module) - pkg-config (to find and use giomm module)
- Qt5Core `>=5.6.3` - Qt5Core `>= 5.6.3`
- Qt5Test (if you would like to build tests) - Qt5Test (if you would like to build tests)
- giomm-2.4 - giomm-2.4
- doxygen (to build documentations) - 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. 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?
<!-- TODO: Update README after 1.0.0 released --> <!-- TODO: Update README after 1.0.0 released -->
@ -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! 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 ## 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. 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.