m4/ax_lib_elfutils.m4: use m4_default() for optional args.

[babeltrace.git] / README

diff --git a/README b/README
index 6b8cb0bf6e63320076266d4f42ce884d1d05ac33..c44b5e9892a0bd1f71186c6948e44f120378ad20 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,26 @@
 BabelTrace - Trace Format Babel Tower
-Mathieu Desnoyers, EfficiOS Inc.
-September 2010
 
 This project provides trace read and write libraries, as well as a trace
 converter. A plugin can be created for any trace format to allow its conversion
 to/from another trace format.
 
+The main format expected to be converted to/from is the Common Trace
+Format (CTF). The latest version of the CTF specification can be found at:
+
+  git tree:   git://git.efficios.com/ctf.git
+  gitweb:     http://git.efficios.com/?p=ctf.git
+
+The CE Workgroup of the Linux Foundation, Ericsson, and EfficiOS have
+sponsored this work.
+
+The current maintainers are:
+  Jérémie Galarneau <jeremie.galarneau@efficios.com>
+  Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+
+Questions should be addressed to this mailing list:
+  lttng-dev@lists.lttng.org
+
+
 BUILDING
 --------
 
@@ -13,6 +28,7 @@ BUILDING
        ./configure
        make
        make install
+       ldconfig
 
 
 DEPENDENCIES
@@ -21,18 +37,34 @@ DEPENDENCIES
 To compile Babeltrace, you will need:
 
        gcc 3.2 or better
-       glib 2.22 or better development libraries
-         (Debian : libglib2.0-0, libglib2.0-dev)
-         (Fedora : glib2, glib2-devel)
        libc6 development librairies
          (Debian : libc6, libc6-dev)
          (Fedora : glibc, glibc)
+       glib 2.22 or better development libraries
+         (Debian : libglib2.0-0, libglib2.0-dev)
+         (Fedora : glib2, glib2-devel)
        uuid development libraries
          (Debian : uuid-dev)
          (Fedora : uuid-devel)
-       libpopt development libraries
-         (Debian : libpopt0, libpopt-dev)
+       libpopt >= 1.13 development libraries
+         (Debian : libpopt-dev)
          (Fedora : popt)
+       elfutils >= 0.154 development libraries (optional)
+         (Debian : libelf-dev, libdw-dev)
+         (Fedora : elfutils-devel, elfutils-libelf-devel)
+       python headers (optional)
+         (Debian/Ubuntu : python3-dev)
+       swig >= 2.0 (optional)
+         (Debian/Ubuntu : swig2.0)
+       python 3.0 or better (optional)
+         (Debian/Ubuntu : python3)
+
+  If you want Python bindings, run ./configure --enable-python-bindings.
+  Please note that some distributions will need the following
+  environment variables set before running configure:
+
+    export PYTHON="python3"
+    export PYTHON_CONFIG="/usr/bin/python3-config"
 
 For developers using the git tree:
 
@@ -42,7 +74,7 @@ compile the git repository tree :
 
 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
   (make sure your system wide "automake" points to a recent version!)
-- GNU Libtool
+- GNU Libtool >=2.2
   (for more information, go to http://www.gnu.org/software/autoconf/)
 - Flex >=2.5.35.
 - Bison >=2.4.
@@ -50,3 +82,5 @@ compile the git repository tree :
 If you get the tree from the repository, you will need to use the "bootstrap"
 script in the root of the tree. It calls all the GNU tools needed to prepare the
 tree configuration.
+
+Running "make check": bash is required.