X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=README;h=3d7e18e3de27f59a124de7ecbf0a9d4f64f5ec9c;hb=7a9c21bd702ae4d54d8c1f623e9837e0248b0643;hp=187c045244a6ccd07826d15f66c0e0fd539ff42f;hpb=618f74d9b64410da1c0684c040787198dec03161;p=lttng-ust.git

diff --git a/README b/README
index 187c0452..3d7e18e3 100644
--- a/README
+++ b/README
@@ -7,8 +7,8 @@ Updated versions of this package may be found at:
 
   * Website:  http://lttng.org/ust
   * Releases: http://lttng.org/files/ust/releases
-  * GitWeb:   http://git.dorsal.polymtl.ca (project: ust)
-  * Git:      git://git.dorsal.polymtl.ca/git/ust.git
+  * GitWeb:   http://git.lttng.org (project: ust)
+  * Git:      git://git.lttng.org/ust.git
 
 
 PREREQUISITES:
@@ -16,7 +16,7 @@ PREREQUISITES:
   - liburcu
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-    -> This release was tested with liburcu v0.5.4
+    -> This release depends on liburcu v0.6
 
       * Debian/Ubuntu package: liburcu-dev
       * Website:  http://lttng.org/urcu
@@ -38,6 +38,19 @@ INSTALLATION INSTRUCTIONS:
   the configure script, to generate it.
 
 
+USAGE:
+
+  - Create an instrumentation header following the tracepoint examples.
+    (see tracepoint.h and tests/hello/tp.h).
+  - Link application with -lust.
+  - (TODO: start tracing with the "lttng" command from lttng-tools)
+
+  Note: libust debug can be activated by either of the following means:
+    - Setting the environment variable "UST_DEBUG" when launching the
+      application.
+    - Compiling libust with -DUST_DEBUG.
+
+
 TRACE VIEWER:
 
   LTTV is used for viewing UST traces. LTTV may be obtained at
@@ -46,6 +59,12 @@ TRACE VIEWER:
   This release has been tested with LTTV 0.12.32.
 
 
+CONTACT:
+
+  Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+  Mailing list: ltt-dev@lists.casi.polymtl.ca
+
+
 PACKAGE CONTENTS:
 
   This package contains the following elements.