added README
authorKevron Rees <kevron_m_rees@linux.intel.com>
Tue, 5 Jun 2012 21:03:43 +0000 (14:03 -0700)
committerKevron Rees <kevron_m_rees@linux.intel.com>
Tue, 5 Jun 2012 21:03:43 +0000 (14:03 -0700)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..8ac2182
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+Automotive Message Broker is built using CMake.  glib2 (with gio) and boost are the only dependencies
+aside from the normal c/c++ toolchain.  Alternatively, Automotive Message Broker can be built to use
+the Qt mainloop.  In this case QtCore is also a dependency.
+
+To build:
+
+cd automotive-message-broker
+mkdir build
+cd build
+cmake ..
+make
+
+To install:
+
+sudo make install
+
+TODO: link to website for questions/comments
+