diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-10-17 10:42:20 +0200 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-10-17 10:42:20 +0200 |
| commit | 45684a0975478530830dec32df3fd326e560dadb (patch) | |
| tree | e339f474b248d6d1ccdebacfc28097afad61416b /docs | |
| parent | 019a32aebc159ea7108b977747fed56f24c05da4 (diff) | |
Merge Install and Usage documentation
Change-Id: Ifa7688c52bcc8c9b9a9c51e53f0df9250fa033eb
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/2-Install-Usage.md (renamed from docs/3-Usage.md) | 34 | ||||
| -rw-r--r-- | docs/2-Installation.md | 34 | ||||
| -rw-r--r-- | docs/SUMMARY.md | 3 |
3 files changed, 35 insertions, 36 deletions
diff --git a/docs/3-Usage.md b/docs/2-Install-Usage.md index 3467935..a5e5765 100644 --- a/docs/3-Usage.md +++ b/docs/2-Install-Usage.md @@ -1,3 +1,37 @@ +## Installation + +## Prerequisites + +Low level CAN service (>=4.0) must be installed. Prerequisites are the same. + +```bash +$ git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service +``` + +## Clone and build high level binding + +### Build requirements + +* CMake version 3.0 or later +* G++, Clang++ or any C++11 compliant compiler. + +### Clone + +```bash +$ export WD=$(pwd) +$ git clone --recusive https://github.com/iotbzh/high-level-viwi-service.git +``` + +### Build + +```bash +$ cd $WD/high-level-viwi-service +$ mkdir build +$ cd build +$ cmake .. +$ make +``` + # Usage diff --git a/docs/2-Installation.md b/docs/2-Installation.md deleted file mode 100644 index 8432128..0000000 --- a/docs/2-Installation.md +++ /dev/null @@ -1,34 +0,0 @@ -## Installation - -## Prerequisites - -Low level CAN service (>=4.0) must be installed. Prerequisites are the same. - -```bash -$ git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service -``` - -## Clone and build high level binding - -### Build requirements - -* CMake version 3.0 or later -* G++, Clang++ or any C++11 compliant compiler. - -### Clone - -```bash -$ export WD=$(pwd) -$ git clone --recusive https://github.com/iotbzh/high-level-viwi-service.git -``` - -### Build - -```bash -$ cd $WD/high-level-viwi-service -$ mkdir build -$ cd build -$ cmake .. -$ make -``` - diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 504de46..7a3df1f 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -3,6 +3,5 @@ * [Abstract](README.md) * [Document revisions](Doc-Revisions.md) * [Architecture](1-Architecture.md) -* [Installation](2-Installation.md) -* [Usage](3-Usage.md) +* [Installation_Usage](2-Install-Usage.md) |