X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=ltt%2Fbranches%2Fpoly%2FREADME;h=f8491f6fc61b634c3923e7a8e82c5b3720d27c77;hb=dde7fe13f03da8653a6892d875ddf92bf7bcd1f6;hp=0adf43d7fc3bfce275d3173cab914e390615bb73;hpb=857ed9777082bdc9876a65f886f7b616bf8dba00;p=lttv.git

diff --git a/ltt/branches/poly/README b/ltt/branches/poly/README
index 0adf43d7..f8491f6f 100644
--- a/ltt/branches/poly/README
+++ b/ltt/branches/poly/README
@@ -1,11 +1,20 @@
+
+This package contains the trace reading library and trace viewing tools for
+the new Linux Trace Toolkit trace format. The associated kernel files to
+generate the new traces are not yet included. In the meantime, a converter
+from the old trace format to the new is provided. For more detailed information
+see doc/developer/index.html
+
 * Compiling
 
-Some development libraries are needed for compiling :
+gcc 3.2 or higher
 
-gtk 2 development libraries (libgtk2.0-dev)
-glib 2 development libraries (libglib2.0-dev)
-libpopt development libraries (libpopt-dev)
+Some development libraries are needed for compiling :
 
+gtk 2 development libraries (libgtk2.0, libgtk2.0-dev)
+glib 2 development libraries (libglib2.0-0, libglib2.0-dev)
+libpopt development libraries (libpopt0, libpopt-dev)
+libpango development libraries (libpango1.0, libpango1.0-dev)
 
 To compile the source tree from a tarball, simply follow these steps :
 
@@ -17,21 +26,40 @@ After running ./configure, you can also go in specific subdirectories and
 use make, make install.
 
 
+* Quick Start
+
+- Create a trace
+- Convert it
+- Run ./lttv -m guievents -m guicontrolflow -m guievents -t path_to_trace
+
+
 * Source Tree Structure
 
 This is a sample of the suggested tree for Linux Trace Toolkit.
 
-LibLTT : Libraries used for LTT.
-README : This file. Introduction pointing to specific resources in the tree.
-debian : debian config files.
-doc :    LTT Documentation.
-doc/user :      User related documentation.
-doc/developer : Developer related documentation.
-kernel : LTT kernel patches.
-lttd :   Linux Trace Toolkit daemon.
-lttv :   Linux Trace Toolkit visualizer/analyzer.
-lttv/plugins :  Linux Trace Toolkit visualizer plugins.
-specs :  RPM config files.
+ltt: new trace format reading library (and converter).
+README: This file.
+debian: debian config files (currently empty).
+doc:    Documentation.
+doc/user:      User related documentation.
+doc/developer: Developer related documentation.
+kernel: Linux Trace Toolkit kernel code (currently empty).
+lttd:   Linux Trace Toolkit daemon (currently empty).
+lttv:   Linux Trace Toolkit trace analysis tool and viewer.
+lttv/modules:  Linux Trace Toolkit analysis tool and viewer plugin modules.
+specs:  RPM config files (currently empty).
+
+
+* The rest of the tools
+
+You must use the lastest versions of patches for the Linux Kernel. That includes
+relayfs and ltt patches, available on the ltt-dev mailing list at
+http://www.listserv.shafik.org/pipermail/ltt-dev/. You will find there the
+lastest version of the trace daemon that must be used to create the traces. (in
+the TraceToolkit package)
+
+Once your traces are created, you must use the convert tool to create a trace in
+the proper format from them.
 
 
 * For Developers
@@ -50,4 +78,5 @@ If you get the tree from the repository, you will need to use the autogen.sh
 script. It calls all the GNU tools needed to prepare the tree configuration.
 
 
+
 Mathieu Desnoyers