Add lttng-ctl SWIG python bindings
[lttng-tools.git] / README
diff --git a/README b/README
index 033679b7fc3f9147bfd326c57d19ff0dc0f04d46..1898af98472ef7686006bb9bade0024702a5e810 100644 (file)
--- a/README
+++ b/README
@@ -28,6 +28,16 @@ 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
 
 For developers using the git tree:
@@ -62,6 +72,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,11 +83,14 @@ 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:
 
-    - liblttngctl
+    - liblttng-ctl
       The LTTng tracing control library.
 
     - libsessiond-comm (internal)
@@ -97,6 +112,15 @@ PACKAGE CONTENTS:
        - libhashtable (internal)
          Library wrapper over URCU hashtables.
 
+       - libcommon (internal)
+         Contains multiple useful function call used by the whole tree.
+
+       - libcompat (internal)
+         Compatibility library mostly for FreeBSD and Linux.
+       
+       - librelayd (internal)
+         Library for all relayd interactions over the network.
+
        - lttng-relayd
          The relay daemon used for network streaming
 
@@ -117,3 +141,6 @@ PACKAGE CONTENTS:
 
        - doc
          Various documentations and quickstart guide.
+
+       - extras
+         Contains extra data such as bash completion file.
This page took 0.032929 seconds and 4 git commands to generate.