summaryrefslogtreecommitdiff
path: root/SDL_Core/doc/install.txt
diff options
context:
space:
mode:
authorJustin Dickow <jjdickow@gmail.com>2014-03-18 13:46:46 -0400
committerJustin Dickow <jjdickow@gmail.com>2014-03-18 13:46:46 -0400
commitba492fb83c258bc60ca68120ce964a95b41133b5 (patch)
treeaf99c087941d65a19831397c1ec5eb34850cfc7f /SDL_Core/doc/install.txt
parent8504605b01177da2e55bee6abe4c3f20c82da379 (diff)
downloadsmartdevicelink-ba492fb83c258bc60ca68120ce964a95b41133b5.tar.gz
initial commit for API 3.0 (replaced all)
Diffstat (limited to 'SDL_Core/doc/install.txt')
-rw-r--r--SDL_Core/doc/install.txt42
1 files changed, 34 insertions, 8 deletions
diff --git a/SDL_Core/doc/install.txt b/SDL_Core/doc/install.txt
index 73587d432..8076f427b 100644
--- a/SDL_Core/doc/install.txt
+++ b/SDL_Core/doc/install.txt
@@ -17,25 +17,48 @@
Install libraries:
sudo apt-get install libbluetooth3
sudo apt-get install libbluetooth-dev
+
We are using cmake to create build configurations.
Install cmake:
sudo apt-get install cmake
+
Also, make sure the g++ compiler is installed:
sudo apt-get install g++
+
To start web-based HMI we need web-browser with web-socket RFC6455 support.
For example Google Chromium. Install it using:
sudo apt-get install chromium-browser
- Install openssl and development libraries:
- sudo apt-get install openssl libssl-dev
-
+
+ To run InterfaceGenerator some python libraries are required and must be
+ installed with following command:
+ sudo pip install -r tools/InterfaceGenerator/requirements.txt
+
+ For logging Apache log4cxx library is used. Install required packages with the following command:
+ sudo apt-get install liblog4cxx10 liblog4cxx10-dev
+
+ For installing pulseaudio development files which neededfor audio management fetures run:
+ sudo apt-get install libpulse-dev
+
+ For installing gstreamer development files which needed for audio management fetures:
+ First add gstreamer repositories to your apt source list (/etc/apt/sources.list):
+ deb http://ppa.launchpad.net/gstreamer-developers/ppa/ubuntu <distributive codename> main
+ deb-src http://ppa.launchpad.net/gstreamer-developers/ppa/ubuntu <distributive codename> main
+ use code name relevant to the Ubuntu version which you use instead of <distributive codename>.
+ Run:
+ sudo apt-get update
+ and:
+ sudo apt-get install gstreamer1.0*
+
* Build application
=================
We support "out of sources" concept for build from R3.0.0
It means all generated by build tools files will be stored in separate folder.
-
+ Temporary build of application requires two steps.
+ 1. Enter src/thirdPartyLibs/logger
+ build logger:
+
1. Create directory outside of SmartDeviceLink project directory.
For example "build" folder in the same folder with SmartDeviceLink git repo folder which has a name "git_repo":
- mkdir build
You will have folders structure like this:
/home/projects/smart_device_link
|--build
@@ -47,7 +70,7 @@
\--CMakeLists.txt
Enter this folder:
cd build
-
+
2. Create build configuration using cmake:
2.1 For Debug configuration
cmake ../git_repo
@@ -55,11 +78,14 @@
cmake -DCMAKE_BUILD_TYPE=Release ../git_repo
2.3 For Debug configuration with tests, run:
cmake -DBUILD_TESTS=On ../git_repo
-
+
3. Make project:
make
-
+
Ready to use release application will be in build/src/appMain/smartDeviceLinkCore
4. If You built configuration with tests (see 2.3 above), then You can run all project tests and see overall result with:
make test
+
+ 5. For creating the doxygen documentation run:
+ make doxygen