X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=README;h=4ef88cb88b310c4157c71b8da35357e419ba4f63;hp=48564002c7b108d86b1033c00e54182957656591;hb=bd2d5dd19e3017f119491213003ef069b8008b24;hpb=2910b812cf17d808f8ad4a07a08c26f239c905a6

diff --git a/README b/README
index 48564002c..4ef88cb88 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,6 +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
@@ -38,15 +53,25 @@ compile the git repository tree :
   (make sure your system wide "automake" points to a recent version!)
 - GNU Libtool >=2.2
   (for more information, go to http://www.gnu.org/software/autoconf/)
+- flex >= 2.5.35
+- bison >= 2.4
+
+If you use GNU gold, which is NOT mandatory, make sure you have this version:
+- GNU gold >= 2.22
+(Before this version we hit a known bug documented at:
+ http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
+Be advise that with GNU gold, you'll might have to specify -L/usr/local/lib in
+LDFLAGS.
 
 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.
+script in the root of the tree. It calls all the GNU tools needed to prepare
+the tree configuration.
 
 INSTALLATION INSTRUCTIONS:
 
   - Download, compile and install the prerequisites.
   Then:
+  $ ./boostrap
   $ ./configure
   $ make
   $ sudo make install
@@ -55,17 +80,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)
@@ -87,6 +120,18 @@ 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
+
     - lttng-consumerd
       The consumer daemon which uses libconsumer.
 
@@ -104,3 +149,6 @@ PACKAGE CONTENTS:
 
 	- doc
 	  Various documentations and quickstart guide.
+
+	- extras
+	  Contains extra data such as bash completion file.