              ~~~===  libcommon INSTALL file ===~~~

== FAST INSTALL

The libcommon sources need no more than the libc6-dev and gcc to be compiled.
In distributions such as debian or ubuntu, the metapackage "build-essential"
is enough for compilation and installation.

In order to install the libcommon, use :

$ ./configure
$ make
# make install (has root)

If the configure file is not present, you need to "bootstrap" the library
See the section (just following) "modifying the sources" in order to do this.

== MODIFYING THE SOURCES

If you whish to modify the sources and add or remove some files, you will need
to modify the Makefile.am files and(or) the configure.ac autotools file.

As a consequence, you need to re-execute the boostrap script.

In order to do this, you need the automake (1.9 or later), autoconf (2.61
or higher) and libtool (2.2 or higher) packages in order to regenerate the
configure and Makefile script.

The regeneration of the configure script is done through the command :

$ ./bootstrap

== INSTALLING THE LIBCOMMON IMPLEMENTATION DOCUMENT

In order to generate the code architecture document, you need some more
packages in order to compile the comments and create the pdf and html files.

The libcommon documentation creation is done through the doxygen utility.
You need this package in order to generate the latex source and the html
sources.

This utility can be found among most of the standard Linux distributions.

Although, in order to generate the pdf, the latex suite packages is needed.

In debian-based distributions, the following packages are needed :

texlive
texlive-base
texlive-latex-base
texlive-latex-recommended
texlive-pstricks
texlive-pictures
texlive-extra-utils
texlive-fonts-recommended
texlive-font-utils
texline-latex-extra

When this packages are installed, you can run a make doc in the root of the
sources :

$ make doc

This command will generate a complete pdf file in the doc/ directory, and a
/doc/html directory containing an online documentation with the same contents.

== CROSS-COMPILING

The libcommon has been checked on the following hardware, and may be
functionnal on some others :

- i386
- IA64
- PowerPC
- MIPS64

The autotool based configure allows you to simply cross-compiling the
libcommon.
Be sure to have the cross-compilators in your PATH first !

first, export the CROSS_COMPILE variable, which contains the prefix of the
cross-compilation chain :
if you have a compiler for ppc, named ppc_060x-gcc, just do

$ export CROSS_COMPILE=ppc_060x

Then just call the configure script with the following option :

$ ./configure --host=ppc

For other architecture, just change the CROSS_COMPILE variable content and the
arch name.

== BUGS, QUESTION

If you find any bug, strange behaviour or have some question, just send a mail
to : project-libcommon@reseau-libre.net
