ll-database-binding/conf.d/app-templates/docs/dev_guide/2_project_architecture.md

   1 # Project architecture
   2
   3 A typical project architecture would be :
   4
   5 ```tree
   6 <project-root-path>
   7 │
   8 ├── conf.d/
   9 │   ├── autobuild/
  10 │   │   ├── agl
  11 │   │   │   └── autobuild
  12 │   │   ├── linux
  13 │   │   │   └── autobuild
  14 │   │   └── windows
  15 │   │       └── autobuild
  16 │   ├── app-templates/
  17 │   │   ├── README.md
  18 │   │   ├── autobuild/
  19 │   │   │   ├── agl
  20 │   │   │   │   └── autobuild.in
  21 │   │   │   ├── linux
  22 │   │   │   │   └── autobuild.in
  23 │   │   │   └── windows
  24 │   │   │       └── autobuild.in
  25 │   │   ├── cmake/
  26 │   │   │   ├── config.cmake.sample
  27 │   │   │   ├── export.map
  28 │   │   │   └── macros.cmake
  29 │   │   ├── deb/
  30 │   │   │   └── config.deb.in
  31 │   │   ├── rpm/
  32 │   │   │   └── config.spec.in
  33 │   │   └── wgt/
  34 │   │       ├── config.xml.in
  35 │   │       ├── config.xml.in.sample
  36 │   │       ├── icon-default.png
  37 │   │       ├── icon-html5.png
  38 │   │       ├── icon-native.png
  39 │   │       ├── icon-qml.png
  40 │   │       └── icon-service.png
  41 │   ├── packaging/
  42 │   │   ├── config.spec
  43 │   │   └── config.deb
  44 │   ├── cmake
  45 │   │   └── config.cmake
  46 │   └── wgt
  47 │      └── config.xml.in
  48 ├── <libs>
  49 ├── <target>
  50 │   └── <files>
  51 ├── <target>
  52 │   └── <file>
  53 └── <target>
  54     └── <files>
  55 ```
  56
  57 | # | Parent | Description |
  58 | - | -------| ----------- |
  59 | \<root-path\> | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. |
  60 | conf.d | \<root-path\> | Holds needed files to build, install, debug, package an AGL app project |
  61 | app-templates | 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. SHOULD NOT BE MODIFIED MANUALLY !|
  62 | autobuild | conf.d | Scripts generated from app-templates to build packages the same way for differents platforms.|
  63 | cmake | conf.d | Contains at least config.cmake file modified from the sample provided in app-templates submodule. |
  64 | wgt | conf.d | Contains at least config.xml.in template file modified from the sample provided in app-templates submodule for the needs of project (See config.xml.in.sample file for more details). |
  65 | packaging | conf.d | Contains output files used to build packages. |
  66 | \<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. |
  67 | \<target\> | \<root-path\> | A target to build, typically library, executable, etc. |
  68
  69 ## Manage app-templates submodule
  70
  71 ### Update
  72
  73 You may have some news bug fixes or features available from app-templates
  74 repository that you want. To update your submodule proceed like the following:
  75
  76 ```bash
  77 git submodule update --remote
  78 git commit -s conf.d/app-templates
  79 ```
  80
  81 This will update the submodule to the HEAD of master branch repository. Save
  82 the modification by commiting it in your master git project.
  83
  84 ### Checkout submodule to a git tag
  85
  86 You could just want to update at a specified repository tag or branch or commit
  87 , here are the method to do so:
  88
  89 ```bash
  90 cd conf.d/app-templates
  91 # Choose one of the following depending what you want
  92 git checkout <tag_name>
  93 git checkout --detach <branch_name>
  94 git checkout --detach <commit_id>
  95 # Then commit
  96 cd ../..
  97 git commit -s conf.d/app-templates
  98 ```