add average script

[ust.git] / README

diff --git a/README b/README
index d80ebf036b7751f3fcef95f387a98d869a11d0a6..f2bb370f27a6cbf2192403184dc90f346c9c877b 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,11 @@
-LTTNG USERSPACE TRACER
-----------------------
+LTTNG USERSPACE TRACER (UST)
+----------------------------
+
+UST web site and manual: http://lttng.org/ust
 
 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
@@ -12,40 +15,40 @@ Updated versions of this package may be found at:
 PREREQUISITES:
 
   - liburcu
-
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-      * Releases: http://lttng.org/files/ust/releases
-      * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
-      * Git:      git://lttng.org/userspace-rcu.git
-
-      -> This release was tested with liburcu v0.0
-
-
-  - libkcompat
-
-    Linux kernel userspace compatibility library.
-      (Provides userspace ports of some kernel APIs.)
-      * Releases: http://lttng.org/files/ust/releases
-      * GitWeb:   http://git.dorsal.polymtl.ca (project: libkcompat)
-      * Git:      git://git.dorsal.polymtl.ca/git/libkcompat.git
 
-      -> This release was tested with libkcompat v0.0
+    -> This release was tested with liburcu v0.4.3
 
+      * Debian/Ubuntu package: liburcu-dev
+      * Website:  http://lttng.org/urcu
+      * Releases: http://lttng.org/files/urcu
+      * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
+      * Git:      git://lttng.org/userspace-rcu.git
 
 
-INSTALLATION INSTRUCTION:
+INSTALLATION INSTRUCTIONS:
 
-  - Download, compile and install liburcu and libkcompat.
+  - Download, compile and install liburcu.
   - In this package's tree, run ./configure.
   - Run make.
   - Run make install.
   - Run ldconfig.
-  - See the manual in the doc/ directory for usage instructions.
+  - See the manual for usage instructions.
+
+
 
+TRACE VIEWER:
+
+  LTTV is used for viewing UST traces. LTTV may be obtained at
+  http://lttng.org in the Downloads section.
+
+  This release has been tested with LTTV 0.12.30.
 
 
 PACKAGE CONTENTS:
 
+  This package contains the following elements.
+
   - libust
     The actual userspace tracing library that must be linked to the
     instrumented programs.
@@ -57,15 +60,16 @@ PACKAGE CONTENTS:
   - ustd
     The daemon that collects trace data and writes it to the disk.
 
-  - Documentation
+  - doc
+    The documentation.
 
   - hello
     An example application that uses the userspace tracer.
 
-  - libmallocwrap
+  - libustinstr-malloc
     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
     in any program without need to recompile it.
 
-  - libinterfork
+  - libustfork
     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
     calls in order to trace across these calls.