summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-05-04 14:06:08 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2018-10-15 18:21:42 +0200
commit13db4dc9f8a20792092d2c8984af339f98b0b1ad (patch)
tree715aae500733653ddd3b3605b2569845daca7fb6 /README.md
parente3d26a820db76f006ec364c90dc54a689446d998 (diff)
Improve documentation.
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>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index acf2a3a..0c0462d 100644
--- 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