Created an abstract interface for the database handlers.

[profile/ivi/genivi/genivi-audio-manager.git] / README

diff --git a/README b/README
index ec69609..d20ab37 100755 (executable)
--- a/README
+++ b/README
@@ -57,27 +57,32 @@ make
 === Compile Options
 These are the compile options with default values:
 
 === Compile Options
 These are the compile options with default values:
 

- BUILD_SHARED_LIBS                OFF                                                                                                            
- CMAKE_BUILD_TYPE                                                                                                                                
- CMAKE_INSTALL_PREFIX             /usr/local                                                                                                     
- GLIB_DBUS_TYPES_TOLERANT         ON                                                                                                             
- USE_BUILD_LIBS                   ON                                                                                                             
- WITH_DBUS_WRAPPER                ON                                                                                                             
- WITH_DLT                         ON                                                                                                             
- WITH_DOCUMENTATION               OFF                                                                                                            
- WITH_MAIN                        ON                                                                                                             
- WITH_PLUGIN_COMMAND              ON                                                                                                             
- WITH_PLUGIN_CONTROL              ON                                                                                                             
- WITH_PLUGIN_ROUTING              ON                                                                                                             
- WITH_SYSTEMD_WATCHDOG            OFF                                                                                                            
- WITH_TELNET                      ON                                                                                                             
- WITH_TESTS                       ON                                                                                                             
- gmock_build_tests                OFF                                                                                                            
- gtest_build_samples              OFF                                                                                                            
- gtest_build_tests                OFF                                                                                                            
- gtest_disable_pthreads           OFF                                                                                                            
- gtest_force_shared_crt           OFF     
-
+ BUILD_SHARED_LIBS                OFF                                                                                                                                                                             
+ CMAKE_BUILD_TYPE                                                                                                                                                                                                 
+ CMAKE_INSTALL_PREFIX             /usr/local                                                                                                                                                                      
+ GLIB_DBUS_TYPES_TOLERANT         ON                                                                                                                                                                              
+ USE_BUILD_LIBS                   ON                                                                                                                                                                              
+ WITH_COMMAND_INTERFACE_DBUS      ON                                                                                                                                                                              
+ WITH_DATABASE_STORAGE            ON                                                                                                                                                                              
+ WITH_DBUS_WRAPPER                ON                                                                                                                                                                              
+ WITH_DLT                         OFF                                                                                                                                                                             
+ WITH_DOCUMENTATION               ON                                                                                                                                                                                                                                                                                                                                                         
+ WITH_NSM                         OFF                                                                                                                                                                                                                                                                                                                                                       
+ WITH_PLUGIN_COMMAND              ON                                                                                                                                                                              
+ WITH_PLUGIN_CONTROL              ON                                                                                                                                                                              
+ WITH_PLUGIN_ROUTING              ON                                                                                                                                                                              
+ WITH_ROUTING_INTERFACE_ASYNC     OFF                                                                                                                                                                             
+ WITH_ROUTING_INTERFACE_DBUS      ON                                                                                                                                                                              
+ WITH_SYSTEMD_WATCHDOG            OFF                                                                                                                                                                             
+ WITH_TELNET                      OFF                                                                                                                                                                             
+ WITH_TESTS                       OFF                                                                                                                                                                             
+ WITH_TEST_CONTROLLER             OFF                                                                                                                                                                             
+ gmock_build_tests                OFF                                                                                                                                                                             
+ gtest_build_samples              OFF                                                                                                                                                                             
+ gtest_build_tests                OFF                                                                                                                                                                             
+ gtest_disable_pthreads           OFF                                                                                                                                                                             
+ gtest_force_shared_crt           OFF
+    

 === Passing options to cmake:
 
 .-DVERSION="XXX"
 === Passing options to cmake:
 
 .-DVERSION="XXX"


@@ -95,15 +100,24 @@ sets the default telnetport, default 6060. Can be overwriten by command line par
 .-DMAX_TELNETCONNECTIONS="XXX"
 sets the default maximum number of telnetconnections, default is 3
 
 .-DMAX_TELNETCONNECTIONS="XXX"
 sets the default maximum number of telnetconnections, default is 3
 

+.-DNSM_PATH="XXX"
+sets the path of the NSM DBUS interface
+
+.-DNSM_INTERFACE="XXX"
+sets the interface to the NSM DBUS interface
+

 In order to change these options, you can modify this values with ccmake, do the appropriate changes in 
 CmakeList.txt or via the commandline for cmake or (when installed via ccmake)
 
 === Build dependencies
 In order to change these options, you can modify this values with ccmake, do the appropriate changes in 
 CmakeList.txt or via the commandline for cmake or (when installed via ccmake)
 
 === Build dependencies

-You will need to fullfill some dependencies in order to comile the GENIVI AudioManager Daemon, these are:
+Basically, all build dependencies are optional- but you might need to use some if you want to have support for Dbus,
+for example...
+
+You will need optionally fullfill some dependencies in order to comile the GENIVI AudioManager Daemon, these are:

 
 * dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]
 
 * dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]

-* sqlite3 [tested on version 3.6.22]
-* automotive-dlt [greater 2.5.0]                
+* sqlite3 [tested on version 3.6.22] (only when WITH_DATABASE_STORAGE==ON)
+* automotive-dlt [greater 2.5.0] (only when WITH_DLT==ON)        

 * doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]
 
 To install them in a build environment like Ubuntu you can use:
 * doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]
 
 To install them in a build environment like Ubuntu you can use:


@@ -111,6 +125,16 @@ To install them in a build environment like Ubuntu you can use:
 sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential
 ----
 
 sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential
 ----
 

+=== The NodeStateManager
+
+The nodestatemanager headers are needed to compile the audiomanager. If the nodestatemanagerincludes are not found, 
+the headers shipped with the audiomanager are used.
+The nodestatemanager can be retrieved from projects.genivi.org . You can install the headers on you system by
+
+----
+sudo make install-includeHEADERS
+----
+

 For building the tests, you will need the following packages:
 
 * python [tested on version 2.6, should work on higher versions as well]
 For building the tests, you will need the following packages:
 
 * python [tested on version 2.6, should work on higher versions as well]