X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=README;h=0b857dbf6c97e00221f2e0f8496004ff6910a810;hp=f65836344cd3179d06d2ec875e202f84ecbf4f86;hb=534d2592c0566f7c07cd9e9f9385781a65566e16;hpb=5a82525d9b63a791103ade72ffe9d410dc149d22

diff --git a/README b/README
index f65836344..0b857dbf6 100644
--- a/README
+++ b/README
@@ -17,7 +17,7 @@ REQUIREMENTS:
     - liburcu
       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-      -> Tested with liburcu >= v0.6.6
+      -> Tested with liburcu >= v0.7.2
 
       * Debian/Ubuntu package: liburcu-dev
       * Git : git://git.lttng.org/userspace-rcu.git
@@ -28,8 +28,21 @@ REQUIREMENTS:
 
       * Debian/Ubuntu package: libpopt-dev
 
+    - SWIG >= 2.0 (optional)
+      Needed for Python bindings (--enable-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,17 +75,25 @@ 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
 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
 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)
@@ -94,6 +115,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
 
@@ -114,3 +144,6 @@ PACKAGE CONTENTS:
 
 	- doc
 	  Various documentations and quickstart guide.
+
+	- extras
+	  Contains extra data such as bash completion file.