mirror of
https://github.com/QuasarApp/CMake.git
synced 2025-04-26 17:54:43 +00:00
ref #2 Update readme
This commit is contained in:
parent
d55412ed2b
commit
961c1e64d0
5
Docs/ProjectOut.md
Normal file
5
Docs/ProjectOut.md
Normal file
@ -0,0 +1,5 @@
|
||||
# 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.
|
||||
77
Docs/QuasarAppCITargets.md
Normal file
77
Docs/QuasarAppCITargets.md
Normal file
@ -0,0 +1,77 @@
|
||||
# This is description of cmake module QuasarAppCITargets
|
||||
|
||||
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.
|
||||
|
||||
This module implementation next cmake functions:
|
||||
|
||||
---
|
||||
## Testing
|
||||
---
|
||||
**addTestsArg** (name testExec arg) - Name target for test utility of your application.
|
||||
- name - Prefix for target (any word).
|
||||
- testExec - Name of tests utility (without extensions).
|
||||
- arg - Arguments for testExec.
|
||||
|
||||
**addTests** (name testExec) - Name target for test utility of your application (without arguments).
|
||||
- name - Prefix for target (any word).
|
||||
- testExec - Name of tests utility (without extensions).
|
||||
|
||||
**initTests** - Init main test target for testing all added tests, this method need to call before all invoiced addTests methods.
|
||||
|
||||
---
|
||||
## Deployment
|
||||
---
|
||||
**addDeploy** (name targets targetDir) - Add deploy target for deployed your application via CqtDeployer tool.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- targets - This is list of cqtdeployer targets [see CQtDeployer help](https://github.com/QuasarApp/CQtDeployer/wiki/).
|
||||
- targetDir - This is target of directory [see option targetDir](https://github.com/QuasarApp/CQtDeployer/wiki/Options) of CqtDeployer help.
|
||||
|
||||
**addDeployFromFile** (name) - Some as initDeploy but use CQtDeployer.json for configuration.
|
||||
- name - This is prefix of added subtarget (any word)
|
||||
|
||||
**addDeployFromCustomFile** (name file) - Some as initDeploy but use custom path for deployment file for configuration.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- file - This is path to config file of CQtDeployer.
|
||||
|
||||
**addDeploySnap** (name targetDir) - Add to deploy step substeps for create a snap package.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- targetDir - Destanation directroy for snap files.
|
||||
|
||||
**addDeployQIF** (name sourceDir targetDir config) - add to deploy step substeps for create Qt Install FrameWork Installer.
|
||||
- name - This is prefix of added subtarget (any word) location for created installer.
|
||||
- sourceDir - Path to folder with qif template.
|
||||
- config - Path to config file of qif template.
|
||||
|
||||
**addDeployAPK** (name input aliase keystore keystorePass targetDir) - Add subtargets of deploy setep for create signed android apk file.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- input - Path to input android json file: *-deployment-settings.json.
|
||||
- aliase - Alise for key store.
|
||||
- keystore - Path of key store.
|
||||
- keystorePass - Pass of keystore file.
|
||||
- targetDir - Target directory for output apk file.
|
||||
|
||||
**initDeploy** - Create a main deploy target for all addDeploy subtargets. This method need to call before invoiced of all addDeploy methods.
|
||||
|
||||
---
|
||||
## Release
|
||||
---
|
||||
**initRelease** - Сreate the general release target for all subtargets addRelease. This method need to call before invoice all addRelease methods.
|
||||
|
||||
**addReleaseSnap** (name) - Сreate subtargets for publish snap deployed snap package.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
|
||||
**addReleaseQif** (name sourceDir targetDir) - Create subtargets for publish the qif package on qif repository.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- sourceDir - Path to folder with qif template.
|
||||
- targetDir - Path to target directory.
|
||||
|
||||
---
|
||||
## Dcumentation
|
||||
---
|
||||
**initDoc** - Create the general doc target for all subtargets addDoc. This method need to call before invoice all addDoc methods.
|
||||
|
||||
**addDoc** (name doxygenFile) - Create subtargets for generate documentation of cpp code.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- doxygenFile - This is path to doxygen configuration file.
|
||||
---
|
||||
4
Docs/ccache.md
Normal file
4
Docs/ccache.md
Normal file
@ -0,0 +1,4 @@
|
||||
# This is description of cmake module ccache
|
||||
|
||||
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.
|
||||
12
Docs/tr.md
Normal file
12
Docs/tr.md
Normal file
@ -0,0 +1,12 @@
|
||||
# This is description of cmake module TR
|
||||
|
||||
This module provides translations functionality.
|
||||
The tr module contains only prepare QM function.
|
||||
|
||||
---
|
||||
|
||||
**prepareQM** (name sourceDir ts_files) - This function prepare translations for you projects.
|
||||
- name - This is a name of the translations target.
|
||||
- sourceDir - This is root source directory. Update will be scan this dir for prepare translations.
|
||||
- ts_files - This is list of the supported languages.
|
||||
|
||||
72
README.md
72
README.md
@ -1,77 +1,15 @@
|
||||
# This is description of cmake modules was used in QasarApp project
|
||||
|
||||
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.
|
||||
|
||||
This module implementation next cmake functions:
|
||||
You can read all the information about the module you are interested in by clicking on the links below:
|
||||
|
||||
---
|
||||
## Testing
|
||||
- ### [QuasarAppCITargets](/Docs/QuasarAppCITargets.md) - Module contains 2 type methods, it is added and init methods.
|
||||
---
|
||||
**addTestsArg** (name testExec arg) - Name target for test utility of your application.
|
||||
- name - Prefix for target (any word).
|
||||
- testExec - Name of tests utility (without extensions).
|
||||
- arg - Arguments for testExec.
|
||||
|
||||
**addTests** (name testExec) - Name target for test utility of your application (without arguments).
|
||||
- name - Prefix for target (any word).
|
||||
- testExec - Name of tests utility (without extensions).
|
||||
|
||||
**initTests** - Init main test target for testing all added tests, this method need to call before all invoiced addTests methods.
|
||||
|
||||
- ### [TR](/Docs/tr.md) - Module provides translations functionality.
|
||||
---
|
||||
## Deployment
|
||||
- ### [ProjectOut](/Docs/ProjectOut.md) - Module for configure pathes of the targets.
|
||||
---
|
||||
**addDeploy** (name targets targetDir) - Add deploy target for deployed your application via CqtDeployer tool.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- targets - This is list of cqtdeployer targets [see CQtDeployer help](https://github.com/QuasarApp/CQtDeployer/wiki/).
|
||||
- targetDir - This is target of directory [see option targetDir](https://github.com/QuasarApp/CQtDeployer/wiki/Options) of CqtDeployer help.
|
||||
|
||||
**addDeployFromFile** (name) - Some as initDeploy but use CQtDeployer.json for configuration.
|
||||
- name - This is prefix of added subtarget (any word)
|
||||
|
||||
**addDeployFromCustomFile** (name file) - Some as initDeploy but use custom path for deployment file for configuration.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- file - This is path to config file of CQtDeployer.
|
||||
|
||||
**addDeploySnap** (name targetDir) - Add to deploy step substeps for create a snap package.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- targetDir - Destanation directroy for snap files.
|
||||
|
||||
**addDeployQIF** (name sourceDir targetDir config) - add to deploy step substeps for create Qt Install FrameWork Installer.
|
||||
- name - This is prefix of added subtarget (any word) location for created installer.
|
||||
- sourceDir - Path to folder with qif template.
|
||||
- config - Path to config file of qif template.
|
||||
|
||||
**addDeployAPK** (name input aliase keystore keystorePass targetDir) - Add subtargets of deploy setep for create signed android apk file.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- input - Path to input android json file: *-deployment-settings.json.
|
||||
- aliase - Alise for key store.
|
||||
- keystore - Path of key store.
|
||||
- keystorePass - Pass of keystore file.
|
||||
- targetDir - Target directory for output apk file.
|
||||
|
||||
**initDeploy** - Create a main deploy target for all addDeploy subtargets. This method need to call before invoiced of all addDeploy methods.
|
||||
|
||||
- ### [ccache](/Docs/ccache.md) - Module for add support of the ccache.
|
||||
---
|
||||
## Release
|
||||
---
|
||||
**initRelease** - Сreate the general release target for all subtargets addRelease. This method need to call before invoice all addRelease methods.
|
||||
|
||||
**addReleaseSnap** (name) - Сreate subtargets for publish snap deployed snap package.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
|
||||
**addReleaseQif** (name sourceDir targetDir) - Create subtargets for publish the qif package on qif repository.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- sourceDir - Path to folder with qif template.
|
||||
- targetDir - Path to target directory.
|
||||
|
||||
---
|
||||
## Dcumentation
|
||||
---
|
||||
**initDoc** - Create the general doc target for all subtargets addDoc. This method need to call before invoice all addDoc methods.
|
||||
|
||||
**addDoc** (name doxygenFile) - Create subtargets for generate documentation of cpp code.
|
||||
- name - This is prefix of added subtarget (any word).
|
||||
- doxygenFile - This is path to doxygen configuration file.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user