Merge pull request #24 from QuasarApp/task_20

Readme update
This commit is contained in:
Andrei Yankovich 2021-03-29 15:59:54 +03:00 committed by GitHub
commit e6751c86d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,63 +1,13 @@
# QuasarAppLib
Global function for quasar app.
This lib include base functions for the all applications of QuasarApp group.
All methods of the Quasar AppUtils is static
Global functions used in applications QuasarApp.
This lib include include next modules:
* parseParams - parase input data of started application
* argc - count of arguments
* argv - arrat of arguments
* return true if all arguments read else false
* Locales - This module use for parse local files. This module allows you to work with translations.
------------------------
* getStrArg - get string value of key
* key
* return string value of argument
* Params - This module use for parese app params and create log.
------------------------
* getArg - get string value of key
* key
* return string value of argument
* Settings - This is a module that allows you to work with application settings.
------------------------
* Global - This module contains other global functions.
* isEndable - check if enable argument of key
* key
* return true if argument enabled
------------------------
* initLocale init translation of applictaion
* locale - string value of locale. example (en)
* app - app core of qt
* translator - translator core of qt
* return return true if locale funded
# QuasarAppLib
Глобальная функция для приложений quasar.
Эта библиотека включает базовые функции для всех приложений группы QuasarApp.
Все методы Quasar AppUtils являются статическими
* parseParams - парсит входные данные запускаемого приложения
* argc - количество аргументов
* argv - аргумент аргументов
* вернет true, если все аргументы прочитаны верно иначе false
------------------------
* getStrArg - получить строковое значение ключа
* возвращаемое строковое значение аргумента
------------------------
* getArg - получить строковое значение ключа
* возвращаемое строковое значение аргумента
------------------------
* isEndable - проверить, разрешен ли аргумент ключа
* вернет true, если аргумент включен
------------------------
* initLocale инициализирует перевод приложения
* locale - строковое значение locale. пример (en)
* app - ядро приложения qt
* translator - ядро переводчика qt
* вернет true, если все аргументы прочитаны верно иначе false