Signed-off-by: Angus Salkeld asalkeld@redhat.com --- README | 33 +++++++++++++++++++++++++++++++++ 1 files changed, 33 insertions(+), 0 deletions(-)
diff --git a/README b/README index 139597f..e7ebe77 100644 --- a/README +++ b/README @@ -1,2 +1,35 @@
+What is libqb? +-------------- +libqb is a library with the primary purpose of providing high performance +client server reusable features. It provides high performance logging, +tracing, ipc, and poll. +We don't intend be an all encompassing library, but instead provide very +specially focused APIs that are highly tuned for maximum performance for client/server applications. + +For more info look at: +- Our wiki: http://libqb.org +- The doxygen generated manual: http://libqb.org/html/doxygen/ + You can build it yourself with the following commands: + $ make doxygen + $ firefox ./doc/html/index.html + + +Dependencies +------------ +If you want to build the glib example code then you will need +glib-2.0-devel + +If you want to run the tests then you will need +check-devel + +If you want to build the doxygen man pages or html manual you will need +doxygen and graphviz + +Installing from source +---------------------- +$ ./autogen.sh +$ ./configure +$ make +$ sudo make install