Print "binary+offset" when function name can't be resolved

[babeltrace.git] / README

diff --git a/README b/README
index e72ece8a3514d783ecf1d0b184bba8bd7d29cb96..95cc1fca9359c32d8250e95ad0b9bca8dac84087 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,83 @@
 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
+--------
+
+       ./bootstrap (skip if using tarball)
+       ./configure
+       make
+       make install
+       ldconfig
+
+
+DEPENDENCIES
+------------
+
+To compile Babeltrace, you will need:
+
+       gcc 3.2 or better
+       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 >= 1.13 development libraries
+         (Debian : libpopt-dev)
+         (Fedora : popt)
+       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:
+
+This source tree is based on the autotools suite from GNU to simplify
+portability. Here are some things you should have on your system in order to
+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 >=2.2
+  (for more information, go to http://www.gnu.org/software/autoconf/)
+- Flex >=2.5.35.
+- Bison >=2.4.
+
+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.