Documentation fixes

[ust.git] / README

diff --git a/README b/README
index d80ebf036b7751f3fcef95f387a98d869a11d0a6..00a07a9973a5a8dd029da648e788c8cb59358f10 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,7 @@
-LTTNG USERSPACE TRACER
-----------------------
+LTTNG USERSPACE TRACER (UST)
+----------------------------
+
+For the UST manual, see: http://lttng.org/files/ust/manual/ust.html
 
 Updated versions of this package may be found at:
 
@@ -18,7 +20,7 @@ PREREQUISITES:
       * 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
+      -> This release was tested with liburcu v0.3.4
 
 
   - libkcompat
@@ -29,11 +31,11 @@ PREREQUISITES:
       * 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 libkcompat v0.1
 
 
 
-INSTALLATION INSTRUCTION:
+INSTALLATION INSTRUCTIONS:
 
   - Download, compile and install liburcu and libkcompat.
   - In this package's tree, run ./configure.
@@ -44,8 +46,17 @@ INSTALLATION INSTRUCTION:
 
 
 
+TRACE VIEWER:
+
+  LTTV is used for viewing UST traces. LTTV may be obtained at
+  http://lttng.org in the Downloads section.
+
+
+
 PACKAGE CONTENTS:
 
+  This package contains the following elements.
+
   - libust
     The actual userspace tracing library that must be linked to the
     instrumented programs.
@@ -57,7 +68,8 @@ 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.