Fix: multiline COMMAND not supported...
[staging/xdg-launcher.git] / README.md
index 7056900..b28b90a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,8 +11,9 @@ 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.
 
-You'll find simple usage example for different kind of target under the `examples` folder.
-More advanced usage can be saw with the [low-level-can-service](https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service)
+You'll find simple usage example for different kind of target under the
+`examples` folder. More advanced usage can be saw with the
+[low-level-can-service](https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service)
 which mix external libraries, binding.
 
 Typical project architecture
@@ -25,6 +26,14 @@ A typical project architecture would be :
 │
 ├── conf.d/
 │   ├── app-templates/
+│   │   ├── README.md
+│   │   ├── autobuild/
+│   │   │   ├── agl
+│   │   │   │   └── autobuild.sh
+│   │   │   ├── linux
+│   │   │   │   └── autobuild.sh
+│   │   │   └── windows
+│   │   │       └── autobuild.bat
 │   │   ├── cmake/
 │   │   │   ├── config.cmake.sample
 │   │   │   ├── export.map
@@ -42,18 +51,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
 ├── <libs>
 ├── <target>
 ├── <target>
@@ -73,10 +76,11 @@ A typical project architecture would be :
 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 :
+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/app-templates
+git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templatesconf.d/app-templates
 ```
 
 Specify manually your targets, you should look at samples provided in this
@@ -111,7 +115,8 @@ PROJECT_TARGET_ADD(SuperExampleName) --> Adding target to your project
 
 add_executable/add_library(${TARGET_NAME}.... --> defining your target sources
 
-SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties for macros usage
+SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
+for macros usage
 
 INSTALL(TARGETS ${TARGET_NAME}....
 
@@ -187,9 +192,11 @@ Usage :
 project_subdirs_add()
 ```
 
-You also can specify a globbing pattern as argument to filter which folders will be looked for.
+You also can specify a globbing pattern as argument to filter which folders
+will be looked for.
 
-To filter all directories that begin with a number followed by a dash the anything:
+To filter all directories that begin with a number followed by a dash the
+anything:
 
 ```cmake
 project_subdirs_add("[0-9]-*")
@@ -197,11 +204,14 @@ project_subdirs_add("[0-9]-*")
 
 ### project_targets_populate
 
-Macro use to populate widget tree. To make this works you have to specify some properties to your target :
+Macro use to populate widget tree. To make this works you have to specify some
+properties to your target :
 
 * LABELS : specify *BINDING*, *HTDOCS*, *EXECUTABLE*, *DATA*
-* PREFIX : must be empty **""** when target is a *BINDING* else default prefix *lib* will be applied
-* OUTPUT_NAME : Name of the output file generated, useful when generated file name is different from `${TARGET_NAME}`
+* PREFIX : must be empty **""** when target is a *BINDING* else default prefix
+ *lib* will be applied
+* OUTPUT_NAME : Name of the output file generated, useful when generated file
+ name is different from `${TARGET_NAME}`
 
 Always specify  `populate_widget()` macro as the last statement, especially if
 you use ${TARGET_NAME} variable. Else variable will be set at wrong value with
@@ -227,4 +237,5 @@ project_package_build()
 
 ### project_closing_message
 
-Will display the closing message configured in `config.cmake` file. Put it at the end of your project CMake file.
+Will display the closing message configured in `config.cmake` file. Put it at
+the end of your project CMake file.
\ No newline at end of file