Changes: README.dox -> doc/mainpage.dox, a new empty README added, added #include <MDeclarativeCache>

CMakeLists.txt

@@ -110,8 +110,8 @@ else (EXISTS ${Doxygen})
     message(STATUS "Doxygen not found: you're not able to build documentation.")
 endif (EXISTS ${Doxygen})
 
-# Install README.dox
-install(FILES README.dox DESTINATION /usr/share/doc/applauncherd)
+# Install README
+install(FILES README DESTINATION /usr/share/doc/applauncherd)
 
 # Install html documentation
 install(DIRECTORY doc/implementation-documentation DESTINATION /usr/share/doc/applauncherd OPTIONAL)

README

@@ -0,0 +1,3 @@
+!! Add a short and generic description here !!
+
+

doc/doxygen-userdoc.conf

@@ -564,7 +564,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = README.dox src/qdeclarativebooster/mdeclarativecache.h
+INPUT                  = doc/mainpage.dox src/qdeclarativebooster/mdeclarativecache.h
 
 # This tag can be used to specify the character encoding of the source files 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 

doc/mainpage.dox

@@ -625,13 +625,18 @@ instantiates the classes as
       QDeclarativeView view;
 \endcode
 
-it needs to be modified into
+It needs to be modified into:
 
 \code
      QApplication *app = MDeclarativeCache::qApplication(argc, argv);
      QDeclarativeView *window = MDeclarativeCache::qDeclarativeView();
 \endcode
 
+You also need to:
+\code
+    #include <MDeclarativeCache>
+\endcode
+
 The cache class works both with the booster and without it. In the
 non-boosted case there are no pre-created instances, so the cache
 class simply creates the instances on the fly.