Addition of test plugin to test Map and List types, and Map and List fromVariant...

[profile/ivi/automotive-message-broker.git] / README

diff --git a/README b/README
index 38a82f1..b7ac8ce 100644 (file)
--- a/README
+++ b/README
@@ -3,6 +3,12 @@ to applications.
 
 Automotive Message Broker is built using CMake and requires libltdl (libtool), json-glib, and boost packages.  
 
+
+About the Git Tree:
+master is expected to be unstable and may not even compile.  If you want something more stable, checkout one of the 
+release branches (ie, 0.9.0, 0.10.0, etc)
+
+
 To build:
 
 cd automotive-message-broker
@@ -55,5 +61,40 @@ ambd -c configwebsocketsink
 (in another terminal)
 ambd -c configwebsocketsource
 
-TODO: link to website for questions/comments
 
+
+Running with other plugins
+
+To learn about running AMB with other plugins, please see the plugins/*/README.  
+
+
+
+Running with the Qt mainloop:
+
+Some source and sink plugins may want to use the Qt-based mainloop.  To enable the Qt mainloop, run cmake
+with -Duse_qtcore=On:
+
+cmake .. -Duse_qtcore=On
+
+Alternatively, the Qt-based mainloop will be enabled if you enable an Qt-based
+source or sink plugin at compile time.
+
+You will also need to edit your config to enable the Qt-based mainloop:
+
+{
+       "mainloop" : "/usr/lib/automotive-message-broker/qtmainloopplugin.so",
+       "sources" : [...],
+       "sinks" : [...]
+}
+
+NOTE: by default the glib mainloop will be used.
+
+
+
+Questions/Issues/Comments:
+
+Questions or Comments can be emailed to:
+tripzero.kev@gmail.com
+
+Issues can be submitted on our github page:
+https://github.com/otcshare/automotive-message-broker/issues