Fix: using property for global targets list
[apps/app-templates.git] / README.md
index acf2a3a..65bebca 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,17 +39,28 @@ A typical project architecture would be :
 Usage
 ------
 
-Once installed, use them by customize depending on your project with file
-`\<root-path\>/etc/config.cmake`.
+Install the reference files to the root path of your project, then once
+installed, customize your project with file `\<root-path\>/etc/config.cmake`.
+
+Typically, to copy files use a command like:
+
+```bash
+cp -r reference/etc reference/packaging <root-path-to-your-project>
+cp reference/AGLbuild <root-path-to-your-project>
+```
 
 Specify manually your targets, you should look at samples provided in this
 repository to make yours. Then when you are ready to build, using `AGLbuild`
 that will wrap CMake build command:
 
 ```bash
-`./AGLBuild` package
+./AGLbuild package
 ```
 
+AGLbuild is not mandatory to build your project by will be used by `bitbake`
+tool when building application from a Yocto workflow that use this entry point
+to get its widget file.
+
 Or with the classic way :
 
 ```bash
@@ -117,7 +128,7 @@ PROJECT_TARGET_ADD(low-can-demo)
 This will make available the variable `${TARGET_NAME}` set with the specificied
 name.
 
-### search_targets
+### project_subdirs_add
 
 This macro will search in all subfolder any `CMakeLists.txt` file. If found then
 it will be added to your project. This could be use in an hybrid application by
@@ -126,10 +137,10 @@ example where the binding lay in a sub directory.
 Usage :
 
 ```cmake
-search_targets()
+project_subdirs_add()
 ```
 
-### populate_widget
+### project_targets_populate
 
 Macro use to populate widget tree. To make this works you have to specify some properties to your target :
 
@@ -147,7 +158,7 @@ Usage :
 populate_widget()
 ```
 
-### build_widget
+### project_package_build
 
 Use at project level, to gather all populated targets in the widget tree plus
 widget specifics files into a **WGT** archive. Generated under your `build`
@@ -158,3 +169,7 @@ Usage :
 ```cmake
 build_widget()
 ```
+
+### project_closing_message
+
+Will display the closing message configured in `config.cmake` file. Put it at the end of your project CMake file.
\ No newline at end of file