aboutsummaryrefslogtreecommitdiffstats
path: root/docs/part-1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/part-1')
-rw-r--r--docs/part-1/0_Abstract.md2
-rw-r--r--docs/part-1/1_install-client.md2
-rw-r--r--docs/part-1/2_install-xds-server.md7
-rw-r--r--docs/part-1/4_build-first-app.md2
-rw-r--r--docs/part-1/5_debug-first-app.md8
5 files changed, 12 insertions, 9 deletions
diff --git a/docs/part-1/0_Abstract.md b/docs/part-1/0_Abstract.md
index d0e32de..4b583d8 100644
--- a/docs/part-1/0_Abstract.md
+++ b/docs/part-1/0_Abstract.md
@@ -1,4 +1,4 @@
-# Part 1 - Getting Started for Users
+# Part 1 - Getting Started for Users
## Abstract
diff --git a/docs/part-1/1_install-client.md b/docs/part-1/1_install-client.md
index b596e57..4a1d140 100644
--- a/docs/part-1/1_install-client.md
+++ b/docs/part-1/1_install-client.md
@@ -50,7 +50,7 @@ seb@laptop ~$ sudo zypper install agl-xds-gdb
1. Add binary to PATH:
- MacOs: create the .bash_profile `nano .bash_profile` and add `export PATH="/opt/AGL/xds/xds-agent:$PATH`
- - Windows: change the system path via control panel or system settings or
+ - Windows: change the system path via control panel or system settings or
`setx path "C:\AGK\xds\xds-agent;%path%"`
- repeat the previous steps to install other tools depending of your needs:
diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md
index fc80665..a4344f9 100644
--- a/docs/part-1/2_install-xds-server.md
+++ b/docs/part-1/2_install-xds-server.md
@@ -78,7 +78,7 @@ This container (ID=0) exposes following ports:
- 69 : TFTP
- 2222 : ssh
-This container also creates the following volumes (sharing directories between
+This container also creates the following volumes (sharing directories between
inside and outside docker):
| Directory on host | Directory inside docker | Comment |
@@ -87,7 +87,6 @@ inside and outside docker):
| $HOME/ssd/xdt_0 | /xdt | location to store SDKs |
| $HOME/devel/docker/share |/home/devel/share | another shared directory |
-
<!-- note -->
Please refer to **part 2 - xds-server** documentation for additional info.
<!-- endnote -->
@@ -131,7 +130,9 @@ seb@laptop ~$ sudo zypper install agl-xds-server
### Configure xds-server
-_Optional step: nothing to do if you keep default settings_
+<!-- note -->
+>**Optional step**: nothing to do if you keep default settings
+<!-- endnote -->
When `xds-server` is started as a systemd service, default environment variables
are set into `/etc/default/xds-server` file.
diff --git a/docs/part-1/4_build-first-app.md b/docs/part-1/4_build-first-app.md
index d698bab..bb343b1 100644
--- a/docs/part-1/4_build-first-app.md
+++ b/docs/part-1/4_build-first-app.md
@@ -292,8 +292,10 @@ And define your own tasks, here is an example to build [unicens2-binding](https:
> More details about VSC tasks [here](https://code.visualstudio.com/docs/editor/tasks)
#### Qt Creator
+
Please refer to [agl-hello-qml](https://github.com/radiosound-com/agl-hello-qml#clone--build-project) project.
Thanks to Dennis for providing this useful example.
#### Others IDE
+
*Coming soon...*
diff --git a/docs/part-1/5_debug-first-app.md b/docs/part-1/5_debug-first-app.md
index 38f2b67..6a4e95f 100644
--- a/docs/part-1/5_debug-first-app.md
+++ b/docs/part-1/5_debug-first-app.md
@@ -36,9 +36,9 @@ wrappers on `exec` command that allows to cross build your application through `
`XDS_CONFIG`
Config file defining `XDS_xxx` configuration variables. Variables of this file
- will overwrite inherited environment variables. Variables definition may be
- prefixed or not by "export" keyword.
- Here is an example of
+ will overwrite inherited environment variables. Variables definition may be
+ prefixed or not by "export" keyword.
+ Here is an example of configuration file
```bash
# for example:
@@ -80,7 +80,7 @@ Remote XDS server url
### Configuration variables set within gdb init command file
-Above `XDS_xxx` variables may also be defined within gdb init command file
+Above `XDS_xxx` variables may also be defined within gdb init command file
(see --command or -x option of genuine Gdb).
You must respect the following syntax: commented line including `:XDS-ENV:` tag