summaryrefslogtreecommitdiffstats
path: root/docs/part-1/4_build-first-app.md
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-16 15:57:59 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-16 15:57:59 +0100
commit2a297d08d6b686abe9ab8404a15aa892f4832e25 (patch)
tree1b675068143b7f1567e9b81926e402da82f4be1c /docs/part-1/4_build-first-app.md
parent3e719a63b4bbae57d774c34e6c8cff882a328e14 (diff)
Update XDS documentation
- remove documentation duplication for xds-server. Change-Id: Icd76d3a65a3a2ad39438524b0d43d33c0a61d077 Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh> Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/part-1/4_build-first-app.md')
-rw-r--r--docs/part-1/4_build-first-app.md39
1 files changed, 28 insertions, 11 deletions
diff --git a/docs/part-1/4_build-first-app.md b/docs/part-1/4_build-first-app.md
index 997a4b9..f6810d1 100644
--- a/docs/part-1/4_build-first-app.md
+++ b/docs/part-1/4_build-first-app.md
@@ -15,6 +15,7 @@
Let's use _helloworld-native-application_ project as example, so you need first to clone
this project into a directory that will be accessible by `xds-server`.
+
Depending of the project sharing method:
- Cloud sync: you can clone project anywhere on your local disk,
@@ -40,7 +41,9 @@ git clone --recursive https://github.com/iotbzh/helloworld-native-application.gi
### Declare project using XDS Dashboard
Use XDS Dashboard to declare your project. Open a browser and connect to XDS
-Dashboard. URL depends of your config, for example `http://localhost:8800`
+Dashboard.
+
+URL depends of your config, for example `http://localhost:8800`
Open the right sidebar and select `Projects` entry to open project page and then
create/declare a new project by with the plus icon:
@@ -54,14 +57,17 @@ Set `Sharing Type` and paths according to your needs.
![](./pictures/xds-dashboard-prj-1.png){:: style="width:90%; max-width:560px; margin:auto; display:flex"}
Note that XDS creates (if not already exists) a file named `xds-project.conf`
-when you declare a new project. This file may be very useful when you plan to
-use XDS client tools such as `xds-cli` or `xds-gdb`.
+when you declare a new project.
+
+This file may be very useful when you plan to use XDS client tools such as `xds-cli` or `xds-gdb`.
<!-- note -->
-**Note:** when `Path mapping` type is selected, you must clone your project into
+**Note:**
+
+When `Path mapping` type is selected, you must clone your project into
`$HOME/xds-workspace` directory (named **Local Path** in modal window).
-If XDS server is running in the XDS docker container (see [Installation based on Docker container](./2_install-xds-server.md#installation-based-on-docker-container) ),
+If XDS server is running in the XDS docker container (see [Installation based on Docker container](./2_install-xds-server.html#installation-based-on-docker-container) ),
the **Server Path** must be set to `/home/devel/xds-workspace/xxx` where xxx is your
project directory name.
@@ -108,20 +114,26 @@ f9904f70-d441-11e7-8c59-3c970e49ad9b Project_helloworld-service
```
XDS tools, including `xds-cli` are installed by default in `/opt/AGL/bin`
-directory and this path has been added into your PATH variable. If it is not the
-case, just add it manually using `export PATH=${PATH}:/opt/AGL/bin` command line.
+directory and this path has been added into your PATH variable.
+
+If it is not the case, just add it manually using `export PATH=${PATH}:/opt/AGL/bin` command line.
Now to refer your project, just use --id option or use `XDS_PROJECT_ID`
environment variable.
<!-- note -->
-**Note:** short id notation is also supported as soon as given id value is non ambiguous.
+**Note:**
+
+Short id notation is also supported as soon as given id value is non ambiguous.
+
For example, to refer to Project_helloworld-native-application project listed
in above command, you can simply use --id 40 instead of --id 4021617e-ced0-11e7-acd2-3c970e49ad9b
<!-- endnote -->
You also need to determine the ID of the cross SDK you want to use to cross build
-you application. To list installed SDK, use the following command:
+you application.
+
+To list installed SDK, use the following command:
```bash
xds-cli sdks ls
@@ -133,6 +145,7 @@ List of installed SDKs:
```
You are now ready to use XDS to for example cross build your project.
+
Here is an example to build a project based on CMakefile:
```bash
@@ -209,7 +222,9 @@ EOF
This chapter will show you how to create 2 configurations, one to compile your
project natively (using native GNU gcc) and one to cross-compile your project
-using XDS. You can easily switch from one to other configuration using menu
+using XDS.
+
+You can easily switch from one to other configuration using menu
**Run -> Set Project Configuration**.
__Netbeans 8.x :__
@@ -334,7 +349,9 @@ AGL helloworld application based on cmake template.
}
```
-> **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