fix: test_trimmer on macOs and Solaris

[babeltrace.git] / README

diff --git a/README b/README
index 718bb68e5b73265c806ab056d902398d69347383..5e0e76647f81758f936a3aa795b4f85774fc17b9 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,4 @@
 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
@@ -15,6 +13,13 @@ Format (CTF). The latest version of the CTF specification can be found at:
 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
 --------
@@ -32,18 +37,33 @@ 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)
-       uuid development libraries
-         (Debian : uuid-dev)
-         (Fedora : uuid-devel)
-       libpopt development libraries
-         (Debian : libpopt0, libpopt-dev)
+       glib 2.22 or better development libraries
+         (Debian : libglib2.0-0, libglib2.0-dev)
+         (Fedora : glib2, glib2-devel)
+       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 (optional)
+         (Debian/Ubuntu : python3)
+       sphinx >= 1.2 (optional)
+         (Debian/Ubuntu : python3-sphinx)
+
+  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:
 
@@ -53,7 +73,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.
@@ -61,3 +81,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.