summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/1_Quickstart.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2018-01-05 18:06:13 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2018-01-05 18:06:13 +0100
commit66d0ca11fe7e3ba7959492729b1e0ae9bca98540 (patch)
tree15a1073b8b0f3cbea0ed59c52e7de16d07a3ccf4 /docs/dev_guide/1_Quickstart.md
parent4b265031de2f405e44fe595e99c29ffe2cfd72b9 (diff)
Update documentation
Better description to use BINDINGV2 labels. Adding documentation for macros: - add_input_files - set_openapi_filename Change-Id: I7eb685faf4a5d4f92343d826877066b54b0012f0 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/dev_guide/1_Quickstart.md')
-rw-r--r--docs/dev_guide/1_Quickstart.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md
index c0293d1..1df38c1 100644
--- a/docs/dev_guide/1_Quickstart.md
+++ b/docs/dev_guide/1_Quickstart.md
@@ -57,12 +57,10 @@ 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*.
- **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
@@ -82,7 +80,7 @@ Choose between:
```cmake
SET_TARGET_PROPERTIES(${TARGET_NAME}
PREFIX "afb-"
- LABELS "BINDING"
+ LABELS "BINDINGV2"
OUTPUT_NAME "file_output_name")
```