Centralize dependencies, add D-Bus dep. to README.md

[src/app-framework-binder.git] / README.md

diff --git a/README.md b/README.md
index 7eb5434..c54c0f1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,11 +8,40 @@ Final goal is keep the engine public while allowing people to load non open-sour
 libraries especially libmicrohttpd & libjson. Finally what ever Licence is chosen it should be compatible with dependencies and automotive
 industry requirementsas the primary target for this code is AGL. 
 
+### Building
+ Building Application Framework Binder requires the following libraries:
+
+ * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
+ * libmicrohttpd ("libmicrohttpd-dev/devel");
+ * json-c ("libjson-c-dev/devel");
+ * uuid ("uuid-dev/libuuid-devel");
+ * dbus ("libdbus-1-dev/dbus-1-devel");
+
+ optionally, for plugins :
+
+ * alsa ("libasound2-dev/alsa-devel");
+ * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr");
+
+ and the following tools:
+
+ * pkg-config;
+ * cmake >= 2.8.8.
+
+To install all dependencies under OpenSUSE (except rtl-sdr), please type:
+
+$ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel pkg-config cmake
+
+ To build from the root directory, please type:
+
+$ mkdir build; cd build<br />
+$ cmake ..<br />
+$ make; make install<br />
+
 ### Start
-afb-daemon --help 
+$ afb-daemon --help 
 
 ### Example
-afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons
+$ afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons
 
 ### Directory & Path
 Default behaviour is to locate ROOTDIR in $HOME/.AFB