aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/2-Installation.md50
1 files changed, 7 insertions, 43 deletions
diff --git a/docs/2-Installation.md b/docs/2-Installation.md
index 4bb038af..70036b6b 100644
--- a/docs/2-Installation.md
+++ b/docs/2-Installation.md
@@ -44,62 +44,26 @@ You can install any of these using your package manager. For instance, inside th
```bash
$ sudo apt-get update
-$ sudo apt-get install cmake libboost-system-dev libboost-filesystem-dev libboost-program-options-dev
+$ sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev
```
You may want to install `libboost-all-dev` to get all boost components even if it's not required.
### Compile
-> **CAUTION** It is **very important** that you do not source the SDK environment file to compile this project because some build requirements aren't installed in the AGL SDK for now.
+> **CAUTION** It is **very important** that you do not source the SDK environment file to compile this project because some build requirements aren't installed in the AGL SDK for now.
```bash
+$ export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin
$ git clone https://github.com/iotbzh/can-config-generator.git
-Cloning into 'can-config-generator'...
-remote: Counting objects: 74, done.
-remote: Compressing objects: 100% (42/42), done.
-remote: Total 74 (delta 30), reused 67 (delta 27), pack-reused 0
-Unpacking objects: 100% (74/74), done.
-Checking connectivity... done.
-
-<b>devel@bsp-devkit:~/projects/$</b> cd can-config-generator
-<b>devel@bsp-devkit:~/projects/can-config-generator/(master)$</b> mkdir build
-<b>devel@bsp-devkit:~/projects/can-config-generator/build(master)$</b> cmake -G "Unix Makefiles" ..
--- The C compiler identification is GNU 4.9.2
--- The CXX compiler identification is GNU 4.9.2
--- Check for working C compiler: /usr/bin/cc
--- Check for working C compiler: /usr/bin/cc -- works
--- Detecting C compiler ABI info
--- Detecting C compiler ABI info - done
--- Check for working CXX compiler: /usr/bin/c++
--- Check for working CXX compiler: /usr/bin/c++ -- works
--- Detecting CXX compiler ABI info
--- Detecting CXX compiler ABI info - done
--- Boost version: 1.55.0
--- Found the following Boost libraries:
--- program_options
--- filesystem
--- system
--- Configuring done
--- Generating done
--- Build files have been written to: /home/devel/projects/can-config-generator/build
-<b>devel@bsp-devkit:~/projects/can-config-generator/build(master)$</b> make
-Scanning dependencies of target can-config-generator
-[ 12%] Building CXX object CMakeFiles/can-config-generator.dir/src/main.cpp.o
-[ 25%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/message_set.cpp.o
-[ 37%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/can_bus.cpp.o
-[ 50%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/can_message.cpp.o
-[ 62%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/command.cpp.o
-[ 75%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/diagnostic_message.cpp.o
-[ 87%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/mapping.cpp.o
-[100%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/signal.cpp.o
-Linking CXX executable can-config-generator
-[100%] Built target can-config-generator
+$ cd can-config-generator
+$ mkdir build
+$ cmake -G "Unix Makefiles" ..
```
### Naming convention
-We choose a doted naming convention because it's a well know schema.
+We chose a doted naming convention because it's a well know schema.
It separates and organize names into hierarchy. From the left to right, you describe your names using the more common ancestor at the left then more you go to the right the more it will be accurate.