diff --git a/doc/doxygen-userdoc.conf b/doc/doxygen-userdoc.conf index c68e057..2d5bb26 100644 --- a/doc/doxygen-userdoc.conf +++ b/doc/doxygen-userdoc.conf @@ -579,6 +579,7 @@ INPUT = mainpage.dox \ splash.dox \ dbus.dox \ customboosters.dox \ + qtquick.dox \ ../src/qdeclarativebooster/mdeclarativecache.h # This tag can be used to specify the character encoding of the source files diff --git a/doc/mainpage.dox b/doc/mainpage.dox index ce54193..64befff 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -11,6 +11,8 @@ This documentation describes the idea behind this functionality and how to utili - \ref howdoesitwork "How does it work?" +- \ref qtquick " Getting started with Qt Quick applications" + - How to enable boosted startup for different types of applications: - \ref qmlboost "QML" - \ref qtboost "Qt" diff --git a/doc/qtquick.dox b/doc/qtquick.dox new file mode 100644 index 0000000..ce77c28 --- /dev/null +++ b/doc/qtquick.dox @@ -0,0 +1,29 @@ +/*! \page qtquick Getting started with Qt Quick applications + +Fast startup for Qt Quick applications can be achieved by using the +applauncherd daemon and the QML booster. As described in the earlier +section, the applauncherd (daemon) forks the booster process +(in this case QML booster), which in turn is transformed into real +application when user launches a boosted QML application. + +For compiling and linking, special flags are needed. For more details see: \subpage qmlboostcompiling "compiling and linking". + +The QML booster helps reduce application startup latency by creating instances of the classes QApplication and QDeclarativeView in +MDeclarativeCache. For more details on booster cache see: \subpage qmlboostcache "Utilizing the booster cache". + +The invoker can also provide a splash screen for QML application as follows. For more details on splash screen, see \subpage splash "the splash screen documentation." + +\code +/usr/bin/invoker --splash=/usr/share/myApp/splash.jpg --type=d /usr/bin/myApp +\endcode + +Also a single-instance support is provided to allow only one instance of an application at a time. For more details on single instance see \subpage singleinstance "the single-instance documentation." + +\code +/usr/bin/invoker --single-instance --type=d /usr/bin/ +\endcode + +There are certain limitaions and known issues. For more details on limitations see: \subpage limitations "limitations documentation" + +*/ +