summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/2_project_architecture.md
blob: 9e5503f51394c7b7b8becbae53e806edf6ffcc08 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Project architecture

A typical project architecture would be :

```tree
<project-root-path>

├── autobuild/
│   ├── agl
│   │   └── autobuild
│   ├── linux
│   │   └── autobuild
│   └── windows
│       └── autobuild
├── conf.d/
│   ├── packaging/
│   │   ├── rpm
│   │   │   └── package.spec
│   │   └── deb
│   │       ├── package.dsc
│   │       ├── debian.package.install
│   │       ├── debian.changelog
│   │       ├── debian.compat
│   │       ├── debian.control
│   │       └── debian.rules
│   ├── cmake
│   │   ├── 00-debian-osconfig.cmake
│   │   ├── 00-suse-osconfig.cmake
│   │   ├── 01-default-osconfig.cmake
│   │   └── config.cmake
│   └── wgt
│       ├── icon.png
│       └── config.xml.in
├── <target>
│   └── <files>
├── <target>
│   └── <file>
└── <target>
    └── <files>
```

| # | Parent | Description |
| - | -------| ----------- |
| \<root-path\> | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. |
| autobuild | \<root-path\> | Scripts generated from app-templates to build packages the same way for differents platforms.|
| conf.d | \<root-path\> | Holds needed files to build, install, debug, package an AGL app project |
| cmake | conf.d | Contains at least config.cmake file modified from the sample provided in app-templates submodule. |
| packaging | conf.d | Contains output files used to build packages. |
| wgt | conf.d | Contains config.xml.in, and optionnaly test-config.xml.in template files modified from the sample provided in cmake module for the needs of project (See config.xml.in.sample and test-config.xml.in.sample file for more details). |
| \<target\> | \<root-path\> | A target to build, typically library, executable, etc. |