update README

[ust.git] / README

diff --git a/README b/README
index 18874e81d8065cd034d42e241ae981ed0bf1b761..d2f78bc79de7adc991f1a6a7909c52ef846838db 100644 (file)
--- a/README
+++ b/README
@@ -1,26 +1,30 @@
 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 LIBRARIES. IT WILL BE
-RELEASED AS SOON AS THESE ISSUES ARE RESOLVED.
-
 Dependencies:
 
-- liburcu-pmf
-  Userspace RCU library, pmf patches.
-  http://git.dorsal.polymtl.ca
+- 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:
+
+- 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.
+
 Package contents:
 
 - libust
   The actual userspace tracing library that must be linked to the
   instrumented programs.
 
-- ust
+- ustctl
   A program to control the tracing of userspace applications. It can list
   markers, start the tracing, stop the tracing, enable/disable markers, etc.
 
@@ -35,3 +39,7 @@ Package contents:
 - 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.