Add a usage example for the CTF Writer Python bindings

[babeltrace.git] / README

diff --git a/README b/README
index 75bf0cf65464f7171813ff1a5de66dbe5da349bc..ce98e24dc01e23f90a4c4e2bac6c4b87c3c9c4d3 100644 (file)
--- a/README
+++ b/README
@@ -25,6 +25,7 @@ BUILDING
        make install
        ldconfig
 
+       If you do not want Python bindings, run ./configure --disable-python.
 
 DEPENDENCIES
 ------------
@@ -44,6 +45,13 @@ To compile Babeltrace, you will need:
        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:
 
@@ -61,3 +69,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.