summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/0_Abstract.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2018-11-06 16:13:16 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2018-11-07 15:13:11 +0100
commitcf912a41bc481f0789e3ed6d83d97176b295881f (patch)
tree1e70f91d1ab5606083e380c8f160e029dd721f92 /docs/dev_guide/0_Abstract.md
parent1156b45273d1658c7975149d36fc013f3ba96a23 (diff)
Update docs
Since migration to CMake module, the doc needs to be be updated to reflect the change and get rid of all git submodule occurrences. Change-Id: If56c50a845d01dafd6b5dcd46cac7cfb2be76e85 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/dev_guide/0_Abstract.md')
-rw-r--r--docs/dev_guide/0_Abstract.md45
1 files changed, 31 insertions, 14 deletions
diff --git a/docs/dev_guide/0_Abstract.md b/docs/dev_guide/0_Abstract.md
index a04cc87..88e841b 100644
--- a/docs/dev_guide/0_Abstract.md
+++ b/docs/dev_guide/0_Abstract.md
@@ -1,21 +1,38 @@
-# Developper Guide: use AGL CMake Templates
+# Abstract
-## Abstract
+Files used to build an application, or a binding project with the AGL
+Application Framework.
-Files used to build an application, or binding, project with the
-AGL Application Framework.
+To build your AGL project using these templates, you have to installed them as
+a CMake module. The easy way is to install using your distro package manager
+following [this guide](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/host-configuration/docs/1_Prerequisites.html).
-To build your AGL project using these templates, you have to install
-them within your project and adjust compilation option in `config.cmake`.
-For technical reasons, you also have to specify **cmake** target in
-sub CMakeLists.txt installed. Make a globbing search to find source files
-isn't recommended now to handle project build especially in a multiuser
-project because CMake will not be aware of new or removed source files.
+Then install it, depending of your distro:
+
+* **Debian/Ubuntu**
+
+```bash
+sudo apt-get install agl-cmake-apps-module-bin
+```
+
+* **openSUSE**
+
+```bash
+sudo zypper install agl-cmake-apps-module
+```
+
+* **Fedora**
+
+```bash
+sudo dnf install agl-cmake-apps-module
+```
+
+----
You'll find usage samples here:
- [helloworld-service](https://github.com/iotbzh/helloworld-service)
-- [low-level-can-service](https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service)
-- [high-level-viwi-service](https://github.com/iotbzh/high-level-viwi-service)
-- [audio-binding](https://github.com/iotbzh/audio-binding)
-- [unicens2-binding](https://github.com/iotbzh/unicens2-binding)
+- [agl-service-can-low-level](https://gerrit.automotivelinux.org/gerrit/apps/agl-service-can-low-level)
+- [agl-service-audio-4a](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/agl-service-audio-4a)
+- [agl-service-unicens](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/agl-service-unicens)
+- [4a-hal-unicens](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/4a-hal-unicens)