ref #15 Update documentation

Docs/ProjectOut.md

@@ -1,5 +0,0 @@
-# This is description of cmake module ProjectOut
-
-This module configure pathes of the targets.
-If you include this method before adding targets then this
-taken all targets of subproject configured for root project when this has been invoked.

Docs/QtUtils.md

@@ -1,4 +1,5 @@
-# This is description of cmake module QtUtils
+
+# QtUtils module description
 
 Module provides qt utils functions 
 The module provides qt utils functions. This module contains some useful functions. Including provides translations functionality.

Docs/QuasarApp.md

@@ -0,0 +1,17 @@
+
+# QuasarApp module description
+
+This is main cmake module of the QuasarApp group.
+All project of the QuasarApp group ust be use this module in own cmake rro directory.
+Example
+include(CMake/QuasarApp.cmake)
+ 
+**This module do:**
+
+* Print debug information.
+* Prepare build type, By default it is Release mode
+include ccache for project.
+* Add default QussarApp  definition into code.
+* Initialise all default targets. See the QuasarAppCITargets module.
+* Initialise all qtUtils. See the QtUtils module.
+* Initialise all crossplatform toolchains. See the crossplatform module.

Docs/QuasarAppCITargets.md

@@ -1,4 +1,5 @@
-# This is description of cmake module QuasarAppCITargets
+
+# QuasarAppCITargets module description
 
 The library contains 2 methods type it is added methods and init methods.
 All inits method must be invoked before adds methods. If you change order then some add method will be ignored.

Docs/ccache.md

@@ -1,4 +1,5 @@
-# This is description of cmake module ccache
+
+# ccache module description
 
 This module adds support of the ccache.
 If you include this cmake file in the main cmakList file then your project will be use the ccache on to the compilator.

Docs/crossplatform.md

@@ -0,0 +1,17 @@
+
+# crossplatform module description
+
+This module include crossplatform toolchains by target platform. To select target platform set the TARGET_PLATFORM_TOOLCHAIN define.
+
+**Availabel platforms:**
+* wasm32
+* win32-g++
+* win64-g++
+
+**Note:**
+
+For add full support of the wasm32 build you shold use the initWasmSupport method. 
+
+**initWasmSupport** (name deployFile) - This method prepare static build for wasm executable and qt resources.
+* name - This is name of your initialize targets. You can set it as a CMAKE_PROJECT
+* deployFile - This is path to the deploy file of the cqtdepoyer tool. Use it for deploy your site.

README.md

@@ -4,6 +4,6 @@ You can read all the information about the module you are interested in by click
 
 - [QuasarAppCITargets](Docs/QuasarAppCITargets.md) - Module contains 2 type methods, it is added  and init methods.
 - [QtUtils](Docs/QtUtils.md) - Module provides qt utils functions (the work with translation function and the include qt modules fucntion).
-- [ProjectOut](Docs/ProjectOut.md) - Module for configure pathes of the targets.
+- [QuasarApp](Docs/QuasarApp.md) - This is main cmake module of the QuasarApp group.
 - [ccache](Docs/ccache.md) - Module for add support of the ccache.
-
+- [crossplatform](Docs/crossplatform.md) - This module include crossplatform toolchains by target platform.