X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=f49c9cdf077dd4f30da5f078d12fdb48aa3a9a27;hb=5a83e479e50eff90f1d98bd74a9f933a6340e3f6;hp=aa76f3731fb23874e52909f8821d824c424081ac;hpb=7936b1c9c5c7e0d9a53c138a67fc93da6f6990e6;p=staging%2Fxdg-launcher.git diff --git a/README.md b/README.md index aa76f37..f49c9cd 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,15 @@ A typical project architecture would be : │ ├── conf.d/ -│ ├── default/ +│ ├── app-templates/ +│ │ ├── README.md +│ │ ├── autobuild/ +│ │ │ ├── agl +│ │ │ │ └── autobuild.sh +│ │ │ ├── linux +│ │ │ │ └── autobuild.sh +│ │ │ └── windows +│ │ │ └── autobuild.bat │ │ ├── cmake/ │ │ │ ├── config.cmake.sample │ │ │ ├── export.map @@ -42,18 +50,12 @@ A typical project architecture would be : │ │ ├── icon-qml.png │ │ └── icon-service.png │ ├── packaging/ -│ │ ├── config.xml │ │ ├── config.spec │ │ └── config.deb -│ ├── autobuild/ -│ │ ├── agl -│ │ │ └── autobuild.sh -│ │ ├── linux -│ │ │ └── autobuild.sh -│ │ └── windows -│ │ └── autobuild.bat -│ ├── README.md -│ └── config.cmake +│ ├── cmake +│ │ └── config.cmake +│ └── wgt +│ └── config.xml.in ├── ├── ├── @@ -64,7 +66,7 @@ A typical project architecture would be : | - | -------| ----------- | | \ | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. | | conf.d | \ | 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 | +| app-templates | 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. | | \ | \ | 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. | @@ -76,7 +78,7 @@ Usage To use these templates files on your project just install the reference files using **git submodule** then use `config.cmake` file to configure your project specificities : ```bash -git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templates conf.d/default +git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templates conf.d/app-templates ``` Specify manually your targets, you should look at samples provided in this @@ -84,7 +86,7 @@ repository to make yours. Then when you are ready to build, using `autobuild` that will wrap CMake build command: ```bash -./conf.d/default/autobuild/agl/autobuild.mk package +./conf.d/app-templates/autobuild/agl/autobuild.mk package ``` Or with the classic way : @@ -122,7 +124,7 @@ populate_widget() --> add target to widget tree depending upon target properties #### config.xml.in file -To build a widget you need to configure file _config.xml_. This repo +To build a widget you need to configure file _config.xml_. This repo provide a simple default file _config.xml.in_ that will be configured using the variable set in _config.cmake_ file. @@ -171,7 +173,7 @@ Example: PROJECT_TARGET_ADD(low-can-demo) ``` -> ***NOTE***: This will make available the variable `${TARGET_NAME}` +> ***NOTE***: This will make available the variable `${TARGET_NAME}` > set with the specificied name. This variable will change at the next call > to this macros.