Fix: correct name of bt_ctf_field_get_error in comments and typo in man page

[babeltrace.git] / README

diff --git a/README b/README
index 853827864976724826e62ca5cdb909568388de8e..75bf0cf65464f7171813ff1a5de66dbe5da349bc 100644 (file)
--- a/README
+++ b/README
@@ -6,6 +6,16 @@ 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.
 
 converter. A plugin can be created for any trace format to allow its conversion
 to/from another trace format.
 

+The main format expected to be converted to/from is the Common Trace
+Format (CTF). The latest version of the CTF specification can be found at:
+
+  git tree:   git://git.efficios.com/ctf.git
+  gitweb:     http://git.efficios.com/?p=ctf.git
+
+The CE Workgroup of the Linux Foundation, Ericsson, and EfficiOS have
+sponsored this work.
+
+

 BUILDING
 --------
 
 BUILDING
 --------
 


@@ -13,6 +23,7 @@ BUILDING
        ./configure
        make
        make install
        ./configure
        make
        make install

+       ldconfig

 
 
 DEPENDENCIES
 
 
 DEPENDENCIES


@@ -21,12 +32,18 @@ DEPENDENCIES
 To compile Babeltrace, you will need:
 
        gcc 3.2 or better
 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)
        libc6 development librairies
          (Debian : libc6, libc6-dev)
          (Fedora : glibc, glibc)

+       glib 2.22 or better development libraries
+         (Debian : libglib2.0-0, libglib2.0-dev)
+         (Fedora : glib2, glib2-devel)
+       uuid development libraries
+         (Debian : uuid-dev)
+         (Fedora : uuid-devel)
+       libpopt >= 1.13 development libraries
+         (Debian : libpopt-dev)
+         (Fedora : popt)

 
 For developers using the git tree:
 
 
 For developers using the git tree:
 


@@ -34,11 +51,12 @@ 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 :
 
 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)
+- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)

   (make sure your system wide "automake" points to a recent version!)
   (make sure your system wide "automake" points to a recent version!)

-- GNU Libtool
+- GNU Libtool >=2.2

   (for more information, go to http://www.gnu.org/software/autoconf/)
   (for more information, go to http://www.gnu.org/software/autoconf/)

-- Flex and Bison.
+- Flex >=2.5.35.
+- Bison >=2.4.

 
 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
 
 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