common.cmake: fix icon copy and final name in package

[apps/app-templates.git] / README.md

diff --git a/README.md b/README.md
index 0c0462d..d4dc1ef 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,21 +20,51 @@ Typical project architecture
 
 A typical project architecture would be :
 
-* \<root-path\>/
-* \<root-path\>/<libs>
-* \<root-path\>/packaging
-* \<root-path\>/packaging/wgt
-* \<root-path\>/packaging/wgt/etc
-* \<root-path\>/\<target\>/
-
-| # | Parent | Description | Files |
-| - | -------| ----------- | ----- |
-| \<root-path\> | - | Path to your project | Hold master CMakeLists.txt and general files of your projects. |
+```tree
+<project-root-path>
+│
+├── conf.d/
+│   ├── default/
+│   │   ├── cmake/
+│   │   │   ├── config.cmake.sample
+│   │   │   ├── export.map
+│   │   │   └── macros.cmake
+│   │   ├── deb/
+│   │   │   └── config.deb.in
+│   │   ├── rpm/
+│   │   │   └── config.spec.in
+│   │   └── wgt/
+│   │       ├── config.xml.in
+│   │       └── icon.png
+│   ├── packaging/
+│   │   ├── config.xml
+│   │   ├── config.spec
+│   │   ├── icon.png
+│   │   └── config.deb
+│   ├── autobuild/
+│   │   ├── agl
+│   │   │   └── autobuild.sh
+│   │   ├── linux
+│   │   │   └── autobuild.sh
+│   │   └── windows
+│   │       └── autobuild.bat
+│   ├── README.md
+│   └── config.cmake
+├── <libs>
+├── <target>
+├── <target>
+└── <target>
+```
+
+| # | Parent | Description |
+| - | -------| ----------- |
+| \<root-path\> | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. |
+| conf.d | \<root-path\> | Git submodule to app-templates AGL repository which provides CMake helpers macros library, and build scripts. config.cmake is a copy of config.cmake.sample configured for the projects. |
+| default | conf.d | Holds examples files and cmake macros used to build packages |
+| packaging | conf.d | Contains output files used to build packages. |
+| autobuild | conf.d | Scripts used to build packages the same way for differents platforms. |
 | \<libs\> | \<root-path\> | External dependencies libraries. This isn't to be used to include header file but build and link statically specifics libraries. | Library sources files. Can be a decompressed library archive file or project fork. |
-| \<target\> | \<root-path\> | A sub component between: tool, binding, html5, html5-hybrid type. | ----- |
-| packaging | \<root-path\> | Contains folder by package type (rpms, deb, wgt...) | Directory for each packaging type. |
-| wgt | packaging | Files used to build project widget that can be installed on an AGL target. | config.xml.in, icon.png.in files. |
-| etc | wgt | Configuration files for your project. This will be installed in the application root directory under etc/ folder once installed by Application Framework. | specific project configuration files |
+| \<target\> | \<root-path\> | A target to build, typically library, executable, etc. |
 
 Usage
 ------
@@ -45,7 +75,7 @@ installed, customize your project with file `\<root-path\>/etc/config.cmake`.
 Typically, to copy files use a command like:
 
 ```bash
-cp reference/etc reference/packaging <root-path-to-your-project>
+cp -r reference/etc reference/packaging <root-path-to-your-project>
 cp reference/AGLbuild <root-path-to-your-project>
 ```
 
@@ -54,7 +84,7 @@ repository to make yours. Then when you are ready to build, using `AGLbuild`
 that will wrap CMake build command:
 
 ```bash
-./AGLbuild package
+./build.sh package
 ```
 
 AGLbuild is not mandatory to build your project by will be used by `bitbake`
@@ -128,7 +158,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
@@ -137,10 +167,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 :
 
@@ -158,7 +188,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`
@@ -169,3 +199,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.