diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2019-04-11 15:31:33 +0200 |
---|---|---|
committer | Scott Rifenbark <srifenbark@gmail.com> | 2019-05-20 15:18:42 -0700 |
commit | 3635b88a18de43bbdd2373259ac65c02bc63c139 (patch) | |
tree | d3f83a07a32230b938b700cc59419c8c85f42282 /docs/part-1/xds-overview.md | |
parent | 8e5d6918c1a51ae3e948b95c30a357c700821e39 (diff) |
Various review edits for XDS
Took care of review comments from Sebastien
to clear up some terminlogy, update the
create-app-workflow.png image to include
declaring a project. Fixed a link to the
XDS user guide to be guppy-specific.
Included more explanation regarding
aborting an ongoing installation.
v2: squased version due to files being (re-)moved
Change-Id: I48c20d8e0b105f1e26b68b574b2c5d2b56eecb61
Signed-off-by: Scott RifenbarK <srifenbark@gmail.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs/part-1/xds-overview.md')
-rw-r--r-- | docs/part-1/xds-overview.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/part-1/xds-overview.md b/docs/part-1/xds-overview.md new file mode 100644 index 0000000..69a89ce --- /dev/null +++ b/docs/part-1/xds-overview.md @@ -0,0 +1,56 @@ +# Overview + +X(cross) Development System (XDS) is set of tools that provides +multi-platform cross development with +[near-zero](https://en.wikipedia.org/wiki/Zero_Install) +installation. + +This guide is available in two forms: the online version and a PDF +version: + +- Online: [http://docs.automotivelinux.org/docs/en/guppy/devguides/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/en/guppy/devguides/#xcross-development-system-user's-guide) + +- PDF: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf) + +XDS has two goals: + +1. Provide a multi-platform, cross development +tool with near-zero installation. + +2. Keep application source files local to the user's machine, which + makes XDS compatible with existing IT policies + (e.g. corporate backup or SCM), and lets users continue to work + using their favorite editors all while keeping performance during + editing and browsing activities. + +The following illustration shows XDS as two functional blocks: +the client part and the server part. + +The client part consists of several tools some essential and some +required. +The client part must have `xds-agent` and can optionally have `xds-cli` +and `xds-gdb`. +The client part runs on the user's machine (Development Host). + +The server part (`xds-server`) can run anywhere in a container, +which includes a standalone machine, a server machine connected +through a local network, or a server machine connected through the Cloud. + +![](./pictures/xds-block-diagram.png){:: style="width:98%;"} + +<!-- pagebreak --> + +The client part is portable and can run on the following platforms: + +- Linux +- Windows +- MacOS + +The following figure shows the three supported configurations for the client part: + +- standalone (i.e. local) +- On-Premise, which uses a local network +- [Software as a Service](https://en.wikipedia.org/wiki/Software_as_a_service) + (SaaS), which is Cloud-based + +![](./pictures/xds-conf.png){:: style="width:98%;"} |