Add C++ support to API header files

[lttng-tools.git] / README

diff --git a/README b/README
index 48564002c7b108d86b1033c00e54182957656591..fe9e4c2b1c87c05b4c8c959d7be6920ad6a94ab9 100644 (file)
--- a/README
+++ b/README
@@ -28,6 +28,8 @@ REQUIREMENTS:
 
       * Debian/Ubuntu package: libpopt-dev
 
+    - For kernel tracing: modprobe
+
 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify
@@ -38,6 +40,11 @@ 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/)
+- GNU Gold >= 2.22
+  (Before this version we hit a known bug documented at:
+  http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
+- flex >= 2.5.35
+- bison >= 2.4
 
 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
@@ -61,11 +68,14 @@ 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.
+
 PACKAGE CONTENTS:
 
     This package contains the following elements:
 
-    - liblttngctl
+    - liblttng-ctl
       The LTTng tracing control library.
 
     - libsessiond-comm (internal)
@@ -87,6 +97,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 +126,6 @@ PACKAGE CONTENTS:
 
        - doc
          Various documentations and quickstart guide.
+
+       - extras
+         Contains extra data such as bash completion file.