diff options
| author |   Sebastien Douheret <sebastien.douheret@iot.bzh> | 2019-06-27 18:21:39 +0200 |
|---|---|---|
| committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2019-06-27 18:29:11 +0200 |
| commit | 038a391da6eb51110141d5659ea34477942766ab (patch) | |
| tree | 65d754241296f9b063d657068c59aaaf048ab4b9 | |
| parent | da6f9dc2b1917adbaf18d92e0a340238602cf8b4 (diff) | |
Add missing sub-chapters in documentationflounder
Also fix spelling.
Bug-AGL: SPEC-2027
Change-Id: Ibdde0d74844b35344f418e0c12c45602dd65eba0
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
| -rw-r--r-- | docs/README.md | 3 | ||||
| -rw-r--r-- | docs/dev_guide/0_Abstract.md | 6 | ||||
| -rw-r--r-- | docs/devguides-book.yml | 12 |
3 files changed, 15 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md index b0b87bd..4a580d3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,7 @@ # Introduction This document explains how to use the CMake template files and associated -files to ease developement of AGL application. - +files to ease development of AGL application. | *Meta* | *Data* | | -- | -- | diff --git a/docs/dev_guide/0_Abstract.md b/docs/dev_guide/0_Abstract.md index a04cc87..b4bacb6 100644 --- a/docs/dev_guide/0_Abstract.md +++ b/docs/dev_guide/0_Abstract.md @@ -1,4 +1,4 @@ -# Developper Guide: use AGL CMake Templates +# Use AGL CMake Templates ## Abstract @@ -8,8 +8,8 @@ AGL Application Framework. 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 +sub CMakeLists.txt installed. Make a globing search to find source files +isn't recommended now to handle project build especially in a multi-user project because CMake will not be aware of new or removed source files. You'll find usage samples here: diff --git a/docs/devguides-book.yml b/docs/devguides-book.yml index ee3f117..61b6fb9 100644 --- a/docs/devguides-book.yml +++ b/docs/devguides-book.yml @@ -8,5 +8,15 @@ books: author: "IotBzh" version: flounder chapters: - - url: README.md + - url: dev_guide/0_Abstract.md name: Use app-templates + - url: dev_guide/1_Quickstart.md + name: Quickstart + - url: dev_guide/2_project_architecture.md + name: Project architecture + - url: dev_guide/3_advanced_usage.md + name: Advanced usage + - url: dev_guide/4_advanced_customization.md + name: Customization + - url: dev_guide/5_autobuild.md + name: Autobuild |