initial move

[ltt-control.git] / ltt-control / README

diff --git a/ltt-control/README b/ltt-control/README
new file mode 100644 (file)
index 0000000..836472a
--- /dev/null
+++ b/ltt-control/README
@@ -0,0 +1,77 @@
+
+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
+
+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 :
+
+- ./configure
+- make
+- make install
+
+After running ./configure, you can also go in specific subdirectories and
+use make, make install.
+
+
+* Quick Start
+
+See QUICKSTART
+
+* Source Tree Structure
+
+Here is the tree structure of the Linux Trace Toolkit Viewer package.
+
+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
+
+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.
+
+
+
+Mathieu Desnoyers