path: root/README.md
diff options
authorDominik Holland <dominik.holland@pelagicore.com>2018-08-31 16:12:31 +0200
committerDominik Holland <dominik.holland@pelagicore.com>2018-08-31 14:17:51 +0000
commit7ada3952860398bdeef580e2260901a5f33b689e (patch)
tree5313021d46a878129f0dcad64d04188dfb634c9b /README.md
parentc2359cd72a0a7632a524f4f1608b121f532a29b4 (diff)
Introduce a build system for the repository
This enables us to build the needed files and create a package out of it. Change-Id: Ic0ee97401785e1e61d3b4b71bd4d63a54c1efb98 Reviewed-by: Bramastyo Harimukti Santoso <bramastyo.harimukti.santoso@pelagicore.com>
Diffstat (limited to 'README.md')
1 files changed, 60 insertions, 0 deletions
diff --git a/README.md b/README.md
index ba8a6d8..079e5e6 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,63 @@
This repository hosts additional apps provided for installation in the Qt Automotive Suite.
All apps are intended to be packaged by the appman-packager which is part of the QtApplicationManager module.
+# Building and Packaging of Apps
+All apps can be build by using the following commands:
+$ qmake
+$ make
+In addition the apps can be packaged as well using the "package" build target
+$ make package
+# Adding new apps
+## Simple Apps
+For simple QML only apps, just add a new folder with your QML files and icon and the info.yaml for the package.
+The new package needs to be added to the qmake build system. For simple apps this is done by creating a new pro file named the same way like your folder.
+The pro file looks as following:
+FILES += info.yaml \
+ icon.png \
+ Browser.qml
+Also make sure the new folder is added to the toplevel pro file qt-auto-extra-apps.pro
+## Complex Apps
+For more complex apps where you need to deploy a C++ based QML plugin in addition to your QML content you need to do the following:
+1. Create a new folder as described for Simple Apps
+2. Create a new "app" sub-folder and a new "plugin" subfolder
+3. In the plugin subfolder you can use the qmlplugin feature file e.g.
+TARGET = camera
+QT += qml quick
+CONFIG += plugin
+TARGET = $$qtLibraryTarget($$TARGET)
+uri = camera
+# Input
+ camera_plugin.cpp \
+ camerastream.cpp
+ camera_plugin.h \
+ camerastream.h
+OTHER_FILES = qmldir
+4. In the app directory you can use the same template as used in the simple app case.
+5. As the package name is retrieved from the folder name, you need to manually set the package name in your app project file
+e.g. NAME = com.pelagicore.camera
+6. Create a sub-dirs pro file in your global app folder
+7. Add your app folder to the toplevel pro file qt-auto-extra-apps.pro