Update README
[profile/ivi/automotive-message-broker.git] / README
1 Automotive Message Broker is a vehicle network abstraction system.  It brokers information from the vehicle
2 to applications.
3
4 Automotive Message Broker is built using CMake.  
5
6 To build:
7
8 cd automotive-message-broker
9 mkdir build
10 cd build
11 cmake ..
12 make
13
14 To install:
15
16 sudo make install
17
18 To run:
19
20 ambd -c /path/to/config
21
22 ambd can load different plugins.  The config file specifies what plugins to use.  The default config loads the example plugins.  You can change this or use your own config to have ambd use your own plugins.  For example:
23
24 # copy the config to your own config
25 cp config myconfig
26
27 # edit myconfig and specify the path to your plugin:
28 # change the line: 
29 "sources" : [ "../plugins/examplesourceplugin.so" ],
30 # to:
31 "sources" : [ "/path/to/mysourceplugin.so" ],
32
33 Now you can run ambd with:
34
35 ambd -c /path/to/myconfig
36
37 also see ambd -h
38
39 TODO: link to website for questions/comments
40