diff options
author | Dominik Holland <dominik.holland@pelagicore.com> | 2018-04-03 12:45:57 +0200 |
---|---|---|
committer | Antti Hölttä <ahoelttae@luxoft.com> | 2018-04-04 08:57:31 +0000 |
commit | d763b3a951cce576302abe793b2ba64f5f995685 (patch) | |
tree | 510b9218d2f72c623d21d08fbfbd8ecb73e5a4e8 /README.md | |
parent | bdc7254031f551ac3f7378f8b1b506aa1a3c8ec8 (diff) |
Update the README.md
The new README reflects the repository setup and explains the basic
build instructions as well as providing some links to the configuration
documentation available at doc.qt.io
Change-Id: Ibaaf6b1846dc81c9b7bbf966233f9d3956d7f48f
Reviewed-by: Antti Hölttä <ahoelttae@luxoft.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 20 insertions, 23 deletions
@@ -1,44 +1,41 @@ -# Qt Genivi Extras: Platform specific components for GENIVI - -This repository is similar to qtwinextras or qtmacextras and contains specific components for GENIVI based Linux systems. +# Qt Ivi -Currently the only component it contains is a Qt Categorized Logging Binding towards GENIVI DLT (Diagnostic Log and Trace) +This repository hosts multiple Qt modules: the QtIvi modules and the QtGeniviExtras module. -## How to build +# How to build qmake make make install - -## Depedencies -This module has a dependency towards **dlt-daemon** (http://projects.genivi.org/diagnostic-log-trace/about) +# Configuration -The dlt-daemon needs to be installed into the system and needs to be detectable by pkg-config. +By running qmake for the first time, a configuration step runs and tries to detect a configuration that works on your +system. At the end a configuration summary is printed, incl. some notes on what the configuration might be missing +due to dependencies missing. -## Example Usage +Please read this configuration output first and try to fix the dependencies before creating bug reports. -As QDlt is a binding for Qt Categorized Logging you first need to create you logging categories in the header: +The configuration step is based on Qt's configure system and also offers some command-line arguments for enabling/disabling +certain features. More about how to configure qtivi can be found here: - #include <QLoggingCategory> +https://doc-snapshots.qt.io/qtivi/configuration.html - Q_DECLARE_LOGGING_CATEGORY(FOO) - Q_DECLARE_LOGGING_CATEGORY(BAR) +# Qt Genivi Extras: Platform specific components for GENIVI -In the source file you need to define your logging categories, but instead of using the normal Q_LOGGING_CATEGORY() macro you can use QDLT_LOGGING_CATEGORY() instead. +This module is similar to qtwinextras or qtmacextras and contains specific components for GENIVI based Linux systems. - #include <QtGeniviExtras/QtDlt> +Currently the only component it contains is a Qt Categorized Logging Binding towards GENIVI DLT (Diagnostic Log and Trace) - QDLT_REGISTER_APPLICATION("APP1", "Description for APP") +## Depedencies - QDLT_LOGGING_CATEGORY(FOO, "com.pelagicore.foo", "FOO", "FOO CATEGORY") - QDLT_LOGGING_CATEGORY(BAR, "com.pelagicore.bar", "BAR", "BAR CATEGORY") +This module has a dependency towards **dlt-daemon** (https://at.projects.genivi.org/wiki/display/PROJ/Diagnostic+Log+and+Trace) - QDLT_FALLBACK_CATEGORY(FOO) +The dlt-daemon needs to be installed into the system and needs to be detectable by pkg-config. -As DLT works for the whole system it needs to know also a little bit more about your application, which can be done by using QDLT_REGISTER_APPLICATION() +If the dependencies are not satisfied the complete module is disabled and is not built at all. -DLT is using 4 character based idenifiers, this identifier needs to be assigned to your application, as well as to every category you define. +See the QtGeniviExtras documentation for more information: -By using QDLT_FALLBACK_CATEGORY() you can define which DLT category is used when no Qt Category was set for loogging a message e.g. when qWarning(), qDebug() or qCritical() was used +https://doc.qt.io/QtGENIVIExtras/index.html |