Update documentation

[src/xds/xds-agent.git] / README.md

diff --git a/README.md b/README.md
index 190a5e0..fa9c98e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,9 +9,61 @@ machine or container (where `xds-server` is running).
 > **SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a web server
 used to remotely cross build applications.
 
-## How to run
+## How to install xds-agent
 
-First you need to download `xds-agent` tarballs from xds dashboard by clicking
+### Install package for debian distro type
+
+```bash
+export DISTRO="Debian_8.0"
+wget -O - http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Development/${DISTRO}/Release.key | sudo apt-key add -
+sudo bash -c "cat >/etc/apt/sources.list.d/AGL.list<<EOL
+#AGL
+deb http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Development/${DISTRO}/ ./
+EOL
+"
+sudo apt-get update
+sudo apt-get install agl-xds-agent-bin
+```
+
+The value 'DISTRO' can be set to {Debian_8.0, Debian_9.0, xUbuntu_16.04, xUbuntu_16.10, xUbuntu_17.04}
+
+Update the package
+```bash
+sudo apt-get update
+sudo apt-get upgrade agl-xds-agent-bin
+```
+
+The files are install here:
+```bash
+/opt/AGL/agl-xds-agent
+```
+
+### Install package for rpm distro type
+
+#### openSUSE
+```bash
+export DISTRO="openSUSE_Leap_42.2"
+sudo zypper ar http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Development/${DISTRO}/isv:LinuxAutomotive:app-Development.repo
+sudo zypper ref
+sudo zypper install agl-xds-agent
+```
+
+The value 'DISTRO' can be set to {openSUSE_Leap_42.2, openSUSE_Leap_42.3, openSUSE_Tumbleweed}
+
+Update the package
+```bash
+sudo zypper ref
+sudo zypper install --force agl-xds-agent
+```
+
+The files are install here:
+```bash
+/opt/AGL/agl-xds-agent
+```
+
+## How to install on other platform
+
+You need to download `xds-agent` tarballs from xds dashboard by clicking
 on download icon ![download icon](./resources/images/download_icon.jpg) of
 configuration page.