Fix: Add bash requirement to README for make check
[lttng-tools.git] / README
diff --git a/README b/README
index fe9e4c2b1c87c05b4c8c959d7be6920ad6a94ab9..ebd76bdb2105c9cd1e94c732e863c81447a7260c 100644 (file)
--- a/README
+++ b/README
@@ -28,8 +28,21 @@ REQUIREMENTS:
 
       * Debian/Ubuntu package: libpopt-dev
 
+    - SWIG >= 2.0 (optional)
+      Needed for Python bindings
+
+      * Debian/Ubuntu package: swig2.0
+
+    - python-dev (optional)
+      Python headers
+
+      * Debian/Ubuntu package: python-dev
+
     - For kernel tracing: modprobe
 
+       - bash
+         Needed for running "make check".
+
 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify
@@ -62,6 +75,8 @@ INSTALLATION INSTRUCTIONS:
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 
+  If you want Python bindings, run ./configure --enable-python-bindings.
+
 USAGE:
 
 Please see doc/quickstart.txt to help you start tracing. You can also use the
@@ -71,6 +86,9 @@ lttng enable-event -h).
 A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
 helps you understand how to stream a LTTng 2.0 trace.
 
+A Python HOWTO can be found in doc/python-howto.txt which quickly
+helps you understand how to use the Python module to control the LTTng API.
+
 PACKAGE CONTENTS:
 
     This package contains the following elements:
This page took 0.025122 seconds and 4 git commands to generate.