X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fdev_guide%2F1_Quickstart.md;h=e91017840a26ad2905d5acc2225dc5ed3ae03138;hb=02f45f165b15cbd9e5c422a39e8a652a8c6e216b;hp=c0293d1b1db25f1afac94c47b9b415f5e130b19e;hpb=8a77e99d6814db9918cf266a3b9a36f10622d60b;p=apps%2Fapp-templates.git diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md index c0293d1..e910178 100644 --- a/docs/dev_guide/1_Quickstart.md +++ b/docs/dev_guide/1_Quickstart.md @@ -57,12 +57,17 @@ Choose between: - **BINDINGV2**: Shared library that be loaded by the AGL Application Framework This has to be accompagnied with a JSON file named like the *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI - syntax (e.g: *mybinding-apidef*). Or you can choose the name, without the - extension, by setting the *CACHE* cmake variable *OPENAPI_DEF* (***CAUTION***: - setting a CACHE variable is needed, or set a normal variable with the - *PARENT_SCOPE* option to make it visible for the parent scope where the target - is defined) JSON file will be used to generate header file using `afb-genskel` - tool. + syntax (e.g: *mybinding-apidef*). + Or Alternatively, you can choose the name, without the extension, using macro + **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES** + with *CXX*. +- **BINDINGV3**: Shared library that be loaded by the AGL Application Framework + This has to be accompagnied with a JSON file named like the + *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI + syntax (e.g: *mybinding-apidef*). + Or Alternatively, you can choose the name, without the extension, using macro + **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES** + with *CXX*. - **PLUGIN**: Shared library meant to be used as a binding plugin. Binding would load it as a plugin to extend its functionnalities. It should be named with a special extension that you choose with SUFFIX cmake target property or @@ -75,6 +80,7 @@ Choose between: Application Framework - **LIBRARY**: An external 3rd party library bundled with the binding for its own purpose because platform doesn't provide it. +- **BINDING-CONFIG**: Any files used as configuration by your binding. > **TIP** you should use the prefix _afb-_ with your **BINDING* targets which > stand for **Application Framework Binding**. @@ -82,7 +88,7 @@ Choose between: ```cmake SET_TARGET_PROPERTIES(${TARGET_NAME} PREFIX "afb-" - LABELS "BINDING" + LABELS "BINDINGV3" OUTPUT_NAME "file_output_name") ```