summaryrefslogtreecommitdiffstats
path: root/docs/part-2/1_Prerequisites.md
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-18 16:32:27 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-18 16:32:27 +0100
commitdb781221632e5229c585f0a2ebd734785e87af6a (patch)
tree7c189ddcb490c73e36b5f8673084690b811d323c /docs/part-2/1_Prerequisites.md
parent5a700f84793f824ff98323e6c3381ce83379bdc1 (diff)
Update build instructions
Change-Id: Icc394a4aa9c84bad77c69d1ebc54f2f2d53371db Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/part-2/1_Prerequisites.md')
-rw-r--r--docs/part-2/1_Prerequisites.md31
1 files changed, 23 insertions, 8 deletions
diff --git a/docs/part-2/1_Prerequisites.md b/docs/part-2/1_Prerequisites.md
index fcaa031..29ba78b 100644
--- a/docs/part-2/1_Prerequisites.md
+++ b/docs/part-2/1_Prerequisites.md
@@ -1,13 +1,16 @@
# Prerequisites
-To build xds binaries you need to install first [Go](https://golang.org/doc/install) version 1.8.1 or higher and some other tools. To build `xds-server` and `xds-agent`
+XDS is written in Go and currently only build on Linux host has been validated.
+
+So to build XDS binaries you need to install first [Go](https://golang.org/doc/install)
+version 1.8.1 or higher and some other tools. To build `xds-server` and `xds-agent`
you also need to install in addition `nodejs`.
**Ubuntu:**
```bash
# Install various tools
-sudo apt-get install git make npm curl git zip unzip
+sudo apt-get install git make npm curl git zip unzip wget
# Install Go
source /etc/os-release
@@ -17,10 +20,6 @@ deb http://ppa.launchpad.net/longsleep/golang-backports/ubuntu ${VERSION_CODENAM
EOF"
sudo apt-get update
sudo apt-get install golang-go
-
-# Install nodejs LTS version and angular-cli (only mandatory for xds-server and xds-agent)
-sudo npm install --global n @angular/cli
-sudo n lts
```
**openSUSE:**
@@ -36,9 +35,25 @@ sudo zypper ar http://download.opensuse.org/repositories/devel:/languages:/go/${
sudo zypper --gpg-auto-import-keys ref
sudo zypper install go1.9
-# Install nodejs LTS version and angular-cli (only mandatory for xds-server and xds-agent)
+# Install nodejs LTS version (only mandatory for xds-server and xds-agent)
sudo npm install --global n @angular/cli
sudo n lts
```
-Don't forget to open new user session after installing these packages.
+> Don't forget to open new user session after installing these packages.
+
+**All Linux distro:**
+
+```bash
+# Install nodejs LTS version (only mandatory for xds-server and xds-agent)
+sudo npm install --global n
+sudo n lts
+```
+
+Angular developers that's plan to modify XDS Dashboard webapp (part of
+`xds-agent` repo) may also need angular cli tool named `ng` :
+
+```bash
+# Install angular cli tool (ng)
+sudo npm install --global n @angular/cli
+```