Update README, TODO and CodingStyle

[lttng-tools.git] / README

diff --git a/README b/README
index f65836344cd3179d06d2ec875e202f84ecbf4f86..fe9e4c2b1c87c05b4c8c959d7be6920ad6a94ab9 100644 (file)
--- a/README
+++ b/README
@@ -68,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)
@@ -94,6 +97,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 +126,6 @@ PACKAGE CONTENTS:
 
        - doc
          Various documentations and quickstart guide.
+
+       - extras
+         Contains extra data such as bash completion file.