From: Pierre-Marc Fournier <pierre-marc.fournier@polymtl.ca>
Date: Wed, 22 Jul 2009 21:32:00 +0000 (-0400)
Subject: update README
X-Git-Tag: v0.1~175
X-Git-Url: http://git.lttng.org/?a=commitdiff_plain;h=6514bc5d714ea85654b6d28de19a6405918f1af8;hp=34e4b7db790ca5ff678eae7cf5658455a8991870;p=ust.git

update README
---

diff --git a/README b/README
index 18874e8..71ad996 100644
--- a/README
+++ b/README
@@ -1,19 +1,27 @@
 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.
+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.
 
 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