X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=README;h=05a6b56ee6b7cadd6360a622764bd7cfdfa786c2;hb=5de791bd1dae05e595ab74016f7333912f2492a8;hp=1b86fb2030ef77ddcd81005b17724913b64efedb;hpb=55ad629d916dc8a9e0e8859bd469815dc9ec6ceb;p=ust.git

diff --git a/README b/README
index 1b86fb2..05a6b56 100644
--- a/README
+++ b/README
@@ -1,45 +1,80 @@
 LTTNG USERSPACE TRACER
+----------------------
 
-NOTE: This library has not been released yet because altough it is licenced as
-LGPL, it can only be used as gpl because it depends on GPL files. It will be
-released as soon as these issues are resolved.
+Updated versions of this package may be found at:
 
-Dependencies:
+  * Releases: http://lttng.org/files/ust/releases
+  * GitWeb:   http://git.dorsal.polymtl.ca (project: ust)
+  * Git:      git://git.dorsal.polymtl.ca/git/ust.git
 
-- liburcu
-  Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-  http://ltt.polymtl.ca/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
 
-- libkcompat
-  Linux kernel userspace compatibility library.
-  http://git.dorsal.polymtl.ca
 
-Installation instruction:
+PREREQUISITES:
 
-- Download, compile and install liburcu and libkcompat.
-- In this package's tree, run ./configure, specifying the location of
-  liburcu and libkcompat with the --with-urcu and --with-kcompat options.
-- Run make.
-- See the manual in the doc/ directory for usage instructions.
+  - liburcu
 
-Package contents:
+    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
 
-- libust
-  The actual userspace tracing library that must be linked to the
-  instrumented programs.
+      -> This release was tested with liburcu v0.0
 
-- ustctl
-  A program to control the tracing of userspace applications. It can list
-  markers, start the tracing, stop the tracing, enable/disable markers, etc.
 
-- ustd
-  The daemon that collects trace data and writes it to the disk.
+  - libkcompat
 
-- Documentation
+    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
 
-- hello
-  An example application that uses the userspace tracer.
+      -> This release was tested with libkcompat v0.0
 
-- libmallocwrap
-  An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
-  in any program without need to recompile it.
+
+
+INSTALLATION INSTRUCTIONS:
+
+  - Download, compile and install liburcu and libkcompat.
+  - In this package's tree, run ./configure.
+  - Run make.
+  - Run make install.
+  - Run ldconfig.
+  - See the manual in the doc/ directory for usage instructions.
+
+
+
+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.
+
+  - ustctl
+    A program to control the tracing of userspace applications. It can list
+    markers, start the tracing, stop the tracing, enable/disable markers, etc.
+
+  - ustd
+    The daemon that collects trace data and writes it to the disk.
+
+  - Documentation
+
+  - hello
+    An example application that uses the userspace tracer.
+
+  - libmallocwrap
+    An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
+    in any program without need to recompile it.
+
+  - libinterfork
+    A library that is LD_PRELOAD'ed, and that hijacks calls to several system
+    calls in order to trace across these calls.