summaryrefslogtreecommitdiffstats
path: root/docs/part-1
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2017-10-16 17:41:10 +0200
committerSebastien Douheret <sebastien.douheret@iot.bzh>2017-10-16 17:41:10 +0200
commit8c82a12896a17bbd94d107bc15c03b1816a8420c (patch)
treeef6941d425272230ff41bba86787576d03e5bd94 /docs/part-1
parente661ef5b90f40ef61a1f8c0030abcf597c2dcbc6 (diff)
Fixed and improved Note and Warning rendering.
Diffstat (limited to 'docs/part-1')
-rw-r--r--docs/part-1/2_install-xds-server.md6
-rw-r--r--docs/part-1/4_build-first-app.md5
-rw-r--r--docs/part-1/5_debug-first-app.md2
3 files changed, 7 insertions, 6 deletions
diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md
index 8f3d36c..eb9e631 100644
--- a/docs/part-1/2_install-xds-server.md
+++ b/docs/part-1/2_install-xds-server.md
@@ -141,7 +141,7 @@ are set into `/etc/default/xds-server` file.
and default JSON config is `/etc/xds-server/config.json`.
<!-- note -->
->**Note**: you can use your own JSON config by settings `APP_CONFIG` variable of
+>**Note:** you can use your own JSON config by settings `APP_CONFIG` variable of
`/etc/default/xds-server` file to your file, for example
`/home/MYUSER/.xds/server/config.json`
<!-- endnote -->
@@ -155,7 +155,7 @@ Supported fields in JSON configuration file are :
- **sdkRootDir** : root directory where cross SDKs are installed
- **syncthing.binDir** : syncthing binaries directory (default: executable directory)
- **syncthing.home"** : syncthing home directory (usually .../syncthing-config)
-- **syncthing.gui-address** : syncthing gui url (default http://localhost:8384)
+- **syncthing.gui-address** : syncthing gui url (default <http://localhost:8384>)
- **syncthing.gui-apikey** : syncthing api-key to use (default auto-generated)
All fields are optional and example below corresponds to the default values:
@@ -176,7 +176,7 @@ All fields are optional and example below corresponds to the default values:
}
```
->**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
+>**Note:** environment variables are supported by using `${MY_VAR}` syntax.
### Start/Stop xds-server
diff --git a/docs/part-1/4_build-first-app.md b/docs/part-1/4_build-first-app.md
index 342113d..cc3b35e 100644
--- a/docs/part-1/4_build-first-app.md
+++ b/docs/part-1/4_build-first-app.md
@@ -10,7 +10,7 @@ Depending of the project sharing method:
- Path mapping: you must clone project into `$HOME/xds-workspace` directory.
<!-- note -->
-> **Note** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
+> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
project based on [app-templates](https://git.automotivelinux.org/apps/app-templates/)
(included as a git submodule). This CMake templating, used to develop application
with the AGL Application Framework, will automatically generate makefile rules
@@ -268,7 +268,8 @@ And define your own tasks, here is an example to build [unicens2-binding](https:
}
```
-> **NOTE** You can also add your own keybindings to trig above tasks, for example:
+> **Note:** You can also add your own keybindings to trig above tasks, for example:
+>
> ```json
> // Build
> {
diff --git a/docs/part-1/5_debug-first-app.md b/docs/part-1/5_debug-first-app.md
index cc0e8a2..15f58b9 100644
--- a/docs/part-1/5_debug-first-app.md
+++ b/docs/part-1/5_debug-first-app.md
@@ -146,7 +146,7 @@ xds-gdb -x target/gdb-on-root@myTarget.ini
```
<!-- note -->
-> **Note** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
+> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
project based on [app-templates](https://git.automotivelinux.org/apps/app-templates/)
(included as a git submodule). This CMake templating, used to develop application
with the AGL Application Framework, will automatically generate makefile rules