features

[lttv.git] / ltt / branches / poly / README

diff --git a/ltt/branches/poly/README b/ltt/branches/poly/README
index 0adf43d7fc3bfce275d3173cab914e390615bb73..836472ade67c2875f2e634e139e13491b37719bc 100644 (file)
--- a/ltt/branches/poly/README
+++ b/ltt/branches/poly/README
@@ -1,15 +1,33 @@
-* Compiling

 
 

-Some development libraries are needed for compiling :
+This package contains the trace reading library and trace viewing tools for
+the new Linux Trace Toolkit trace format. It also contains the lttd, lttctl and
+liblttctl programs which are necessary to obtain a trace.
+
+* Compiling

 
 

-gtk 2 development libraries (libgtk2.0-dev)
-glib 2 development libraries (libglib2.0-dev)
-libpopt development libraries (libpopt-dev)
+gcc 3.2 or better
+gtk 2.4 or better development libraries
+  (Debian : libgtk2.0, libgtk2.0-dev)
+  (Fedora : gtk2, gtk2-devel)
+  note : For Fedora users : this might require at least core 3 from Fedora,
+  or you might have to compile your own GTK2 library.
+glib 2.4 or better development libraries
+  (Debian : libglib2.0-0, libglib2.0-dev)
+  (Fedora : glib2, glib2-devel)
+libpopt development libraries
+  (Debian : libpopt0, libpopt-dev)
+  (Fedora : popt)
+libpango development libraries
+  (Debian : libpango1.0, libpango1.0-dev)
+  (Fedora : pango, pango-devel)
+libc6 development librairies 
+  (Debian : libc6, libc6-dev)
+  (Fedora : glibc, glibc)

 
 
 To compile the source tree from a tarball, simply follow these steps :
 
 
 
 To compile the source tree from a tarball, simply follow these steps :
 

-- run ./configure
+- ./configure

 - make
 - make install
 
 - make
 - make install
 


@@ -17,21 +35,26 @@ After running ./configure, you can also go in specific subdirectories and
 use make, make install.
 
 
 use make, make install.
 
 

+* Quick Start
+
+See QUICKSTART
+

 * Source Tree Structure
 
 * Source Tree Structure
 

-This is a sample of the suggested tree for Linux Trace Toolkit.
+Here is the tree structure of the Linux Trace Toolkit Viewer package.

 
 

-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.
+README: This file.
+debian: debian config files (currently empty).
+doc:    Documentation.
+doc/user:      User related documentation.
+doc/developer: Developer related documentation.
+liblttctl:    Library to communicate with the kernel tracer control module.
+lttctl:       Command line program to use the liblttctl library.
+lttd:   Linux Trace Toolkit daemon.
+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).

 
 
 * For Developers
 
 
 * For Developers


@@ -50,4 +73,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.
 
 
 script. It calls all the GNU tools needed to prepare the tree configuration.
 
 

+

 Mathieu Desnoyers 
 Mathieu Desnoyers