Added Python 3.0 or better requirement to the README file

[babeltrace.git] / README

diff --git a/README b/README
index 43ca9aa8026fd87938792e73b79c6add5663bd49..ce98e24dc01e23f90a4c4e2bac6c4b87c3c9c4d3 100644 (file)
--- a/README
+++ b/README
@@ -6,18 +6,68 @@ 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:
 
-* For Developers
+  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.
+
+
+BUILDING
+--------
+
+       ./bootstrap (skip if using tarball)
+       ./configure
+       make
+       make install
+       ldconfig
+
+       If you do not want Python bindings, run ./configure --disable-python.
+
+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 : python-dev)
+       swig >= 2.0 (optional)
+         (Debian/Ubuntu : swig2.0)
+       python 3.0 or better (optional)
+         (Debian/Ubuntu : python3)
+
+
+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.7, autoconf >=2.50, autoheader >=2.50)
+- 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.
 
 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.