summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephane Desneux <stephane.desneux@iot.bzh>2017-03-21 23:35:49 +0100
committerStephane Desneux <stephane.desneux@iot.bzh>2017-03-21 23:35:49 +0100
commitaec5f7ddb8f9931e4a65b49949e518c40eda6507 (patch)
tree3d17b7ab39c253c321919b4aad840a7ed5108b78
parent2d67ef7081d7ca0e9df375b1d9e938ce50332afa (diff)
docs: fix Installation guide
Change-Id: Ibd16454f0cbc7f2a3e17f8cf0580174de3df87e3 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
-rw-r--r--docs/2-Installation.md6
-rwxr-xr-xgendocs.sh2
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/2-Installation.md b/docs/2-Installation.md
index d4071a4..410bc4b 100644
--- a/docs/2-Installation.md
+++ b/docs/2-Installation.md
@@ -6,7 +6,7 @@
It will produce a _configuration-generated.cpp_ file to paste in the source, _src/_, directory.
-* Make sure you already set up the AGL SDK using the following [guide](http://docs.iot.bzh/docs/getting_started/en/dev/reference/setup-sdk-environment.html).
+* Make sure you already set up the AGL SDK using the following [SDK Quick Setup Guide](http://docs.iot.bzh/docs/getting_started/en/dev/reference/setup-sdk-environment.html). Alternatively, please refer to official guides available on [AGL Developer Site](http://docs.automotivelinux.org/docs/devguides/en/dev/#guides).
To get the correct SDK version installed, you **must** prepare your environment with the **chinook-next** version. To do so, run the following command in your docker image in the step 4 in place of `... [ prepare build environment ] ...`:
@@ -19,6 +19,8 @@ $ /xdt/build/agl-init-build-env
* An [USB CAN adapter](http://shop.8devices.com/usb2can) connected to connector through the [right cable](http://www.mouser.fr/ProductDetail/EasySync/OBD-M-DB9-F-ES/)).
+<!-- pagebreak -->
+
# Getting started
## Use of CAN config generator
@@ -198,7 +200,7 @@ It's because installation remove the binding before installing it.
If it is the first time that you make the installation then you'll have this message in place of _**true**_.
-### Installation manually
+### Manual Installation
To install it manually, you need to copy the _low-can-binding.wgt_ file on your target, then from it execute the following commands :
diff --git a/gendocs.sh b/gendocs.sh
index 9d9b74a..078fb95 100755
--- a/gendocs.sh
+++ b/gendocs.sh
@@ -57,7 +57,7 @@ if [ "$DO_ACTION" = "pdf" -o "$DO_ACTION" = "serve" ]; then
[ "$?" = "1" ] && { echo "You must install calibre first, using: 'sudo apt install calibre' or refer to https://calibre-ebook.com/download"; exit 1; }
if [ "$DO_ACTION" = "pdf" ]; then
- $DRY $GITBOOK pdf $ROOTDIR $OUT_DIR/LowLevelCanBinder_Guide.pdf $DEBUG_FLAG
+ $DRY $GITBOOK pdf $ROOTDIR $OUT_DIR/LowLevelCanBinding_Guide.pdf $DEBUG_FLAG
else
$DRY $GITBOOK serve $DEBUG_FLAG
fi