X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=ef11607f633d0fed55e70fa880015b24d940de82;hb=1ffa770bdf4f22dfd0c3be0c0a3af0d2b4cca363;hp=f2bb370f27a6cbf2192403184dc90f346c9c877b;hpb=7066ec32b31f6ff4eaf5105e67a71497f3a67002;p=ust.git

diff --git a/README b/README
index f2bb370..ef11607 100644
--- a/README
+++ b/README
@@ -11,7 +11,6 @@ Updated versions of this package may be found at:
   * Git:      git://git.dorsal.polymtl.ca/git/ust.git
 
 
-
 PREREQUISITES:
 
   - liburcu
@@ -35,6 +34,8 @@ INSTALLATION INSTRUCTIONS:
   - Run ldconfig.
   - See the manual for usage instructions.
 
+  If compiling from the git repository, run ./bootstrap before running
+  the configure script, to generate it.
 
 
 TRACE VIEWER:
@@ -57,14 +58,17 @@ PACKAGE CONTENTS:
     A program to control the tracing of userspace applications. It can list
     markers, start the tracing, stop the tracing, enable/disable markers, etc.
 
+  - include
+    The public header files that will be installed on the system.
+
   - ustd
     The daemon that collects trace data and writes it to the disk.
 
   - doc
     The documentation.
 
-  - hello
-    An example application that uses the userspace tracer.
+  - tests
+    Various test programs
 
   - libustinstr-malloc
     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
@@ -72,4 +76,18 @@ PACKAGE CONTENTS:
 
   - libustfork
     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
-    calls in order to trace across these calls.
+    calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
+    in order to hijack calls. In contrast, libust may be linked at build time.
+
+  - libustcmd
+    A library to control tracing in other processes. Used by ustctl.
+
+  - libustcomm
+    A static library shared between libust, ustd and libustcmd, that provides
+    functions that allow these components to communicate together.
+
+  - snprintf
+    An asynchronous signal-safe version of snprintf.
+
+  - java
+    A simple library that uses JNI to allow tracing in java programs.