move struct ctf_stream -> struct ctf_stream_class

[babeltrace.git] / README

diff --git a/README b/README
index e72ece8a3514d783ecf1d0b184bba8bd7d29cb96..aa50ff4998a5d007462f094594c9f05b2ab2e14f 100644 (file)
--- a/README
+++ b/README
@@ -5,3 +5,47 @@ September 2010
 This project provides trace read and write libraries, as well as a trace
 converter. A plugin can be created for any trace format to allow its conversion
 to/from another trace format.
+
+BUILDING
+--------
+
+       ./bootstrap (skip if using tarball)
+       ./configure
+       make
+       make install
+
+
+DEPENDENCIES
+------------
+
+To compile Babeltrace, you will need:
+
+       gcc 3.2 or better
+       glib 2.16 or better development libraries
+         (Debian : libglib2.0-0, libglib2.0-dev)
+         (Fedora : glib2, glib2-devel)
+       libc6 development librairies
+         (Debian : libc6, libc6-dev)
+         (Fedora : glibc, glibc)
+       uuid development libraries
+         (Debian : uuid-dev)
+         (Fedora : uuid-devel)
+       libpopt development libraries
+         (Debian : libpopt0, libpopt-dev)
+         (Fedora : popt)
+
+For developers using the git tree:
+
+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 git repository tree :
+
+- GNU autotools (automake >=1.7, autoconf >=2.50, autoheader >=2.50)
+  (make sure your system wide "automake" points to a recent version!)
+- GNU Libtool
+  (for more information, go to http://www.gnu.org/software/autoconf/)
+- Flex and Bison.
+
+If you get the tree from the repository, you will need to use the "bootstrap"
+script in the root of the tree. It calls all the GNU tools needed to prepare the
+tree configuration.