X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fdev_guide%2F1_Quickstart.md;h=308fc4ead6e56184c561ecccacf78f4138abde24;hb=3465ddbdec8d77e2a59315e50f954ea2d35aa1cb;hp=baf70ae75f090735da9b89d945341b8109e9eedc;hpb=20c82ee40b442e5b64079155e2eafaf22440d1fb;p=apps%2Fapp-templates.git diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md index baf70ae..308fc4e 100644 --- a/docs/dev_guide/1_Quickstart.md +++ b/docs/dev_guide/1_Quickstart.md @@ -1,4 +1,3 @@ - # Quickstart ## Initialization @@ -7,9 +6,9 @@ To use these templates files on your project just install the reference files us **git submodule** then use `config.cmake` file to configure your project specificities : ```bash -git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templatesconf.d/app-templates conf.d/app-templates +git submodule add https://gerrit.automotivelinux.org/gerrit/p/apps/app-templates.git conf.d/app-templates mkdir conf.d/cmake -cp conf.d/app-templates/cmake/config.cmake.sample conf.d/cmake/config.cmake +cp conf.d/app-templates/samples.d/config.cmake.sample conf.d/cmake/config.cmake ``` Edit the copied config.cmake file to fit your needs. @@ -20,7 +19,7 @@ An example is available in **app-templates** submodule that you can copy and use: ```bash -cp conf.d/app-templates/cmake/CMakeLists.txt CMakeLists.txt +cp conf.d/app-templates/samples.d/CMakeLists.txt.sample CMakeLists.txt ``` ## Create your CMake targets @@ -29,7 +28,7 @@ For each target part of your project, you need to use ***PROJECT_TARGET_ADD*** to include this target to your project. Using it, make available the cmake variable ***TARGET_NAME*** until the next -***PROJECT_TARGET_ADD*** is invoked with a new target name. +***PROJECT_TARGET_ADD*** is invoked with a new target name. So, typical usage defining a target is: @@ -70,6 +69,9 @@ Choose between: - **EXECUTABLE**: Entry point of your application executed by the AGL Application Framework +> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which +> stand for **Application Framework Binding**. + ```cmake SET_TARGET_PROPERTIES(${TARGET_NAME} PREFIX "afb-" @@ -77,5 +79,6 @@ SET_TARGET_PROPERTIES(${TARGET_NAME} OUTPUT_NAME "file_output_name") ``` -> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which -> stand for **Application Framework Binding**. +> **NOTE**: You doesn't need to specify an **INSTALL** command for these +> targets. This is already handle by template and will be installed in the +> following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**