Improve documentation.
authorRomain Forlot <romain.forlot@iot.bzh>
Thu, 4 May 2017 12:06:08 +0000 (14:06 +0200)
committerRomain Forlot <romain.forlot@iot.bzh>
Thu, 4 May 2017 12:06:08 +0000 (14:06 +0200)
Added more detailled instruction about installation of these files.
Added the explanation of the AGLbuild script purpose.

Change-Id: I0ba3c51940215fb6c90c02e3950abf445ee21ed6
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
README.md

index acf2a3a..0c0462d 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 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