Add copyright notices and some comments about status and TODO

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

diff --git a/ltt/branches/poly/README b/ltt/branches/poly/README
index 30cd84fd9d9cb139663a908b6bf1b89ad7989d29..d1e6a82bee83580a36133cf8752142688c9d6ae4 100644 (file)
--- a/ltt/branches/poly/README
+++ b/ltt/branches/poly/README
@@ -1,24 +1,60 @@
-To compile the source tree, simply follow these steps :
 
-- run ./autogen.sh
+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 :
+
+gtk 2 development libraries (libgtk2.0-dev)
+glib 2 development libraries (libglib2.0-dev)
+libpopt development libraries (libpopt-dev)
+libpango development libraries (libpango-dev)
+
+To compile the source tree from a tarball, simply follow these steps :
+
+- run ./configure
 - make
 - make install
 
-After running autogen.sh, you can also go in specific subdirectories and
+After running ./configure, you can also go in specific subdirectories and
 use make, make install.
 
 
+* Source Tree Structure
+
 This is a sample of the suggested tree for Linux Trace Toolkit.
 
+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).
+
+
+* For Developers
+
+This source tree is based on the autotools suite from GNU to simplify
+portability. Here are some things you should have on your system in order to
+compile the subversion repository tree :
+
+
+GNU autotools (automake-1,7, autoconf2.50, autoheader2.50)
+(make sure your system wide "automake" points to version 1.7!)
+GNU Libtool
+(for more information, go to http://www.gnu.org/software/autoconf/)
+
+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.
+
 
-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.
+Mathieu Desnoyers