installLibs.README
1-----------------------
2Installation of XLiFE++
3-----------------------
4
5-> The documentation and other related informations can be found at
6 http://uma.ensta-paristech.fr/soft/XLiFE++/
7
8To install, open a terminal, change to the directory containing this file and
9type in the command:
10
11bash installLibs
12 (do not use sh nor dash under Ubuntu)
13
14Nota:
15 By default, the name of the C++ compiler is g++. This can be changed by
16 setting the environment variable CPPCMP. For example:
17 C-shell: setenv CPPCMP clang++ ; bash installLibs
18 Bourne-shell: export CPPCMP=clang++ ; bash installLibs
19
20------------------------
21Usage after installation
22------------------------
23Let $XLDIR stand for the installation directory, so that the directory containing
24this file is $XLDIR/etc.
25Once the installation is performed correctly, the libraries can be used with the
26help of the script $XLDIR/etc/xlmake. The recommended usage is as follows:
27 1. Create a new directory to gather all the source files related to the problem
28 to be solved.
29 2. In this directory, create the source files. One of them should be a valid
30 "XLiFE++ main file", see user documentation. For example, start by copying
31 one of the files present in $XLDIR/examples.
32 3. In a terminal, change to this directory and type in the command:
33 $XLDIR/etc/xlmake
34 This will compile all the C++ source files contained in the current working
35 directory (valid extension are standard ones .c++, .cpp, .cc, .C, .cxx) and
36 create the corresponding executable file, named xlifeppexec.
37 4. Launch the execution of the program by typing in:
38 ./xlifeppexec
39
40Alternatively, one can:
41 - make a link to the script xlmake in the working directory, as suggested in
42 the commentary inside the script,
43 - or add $XLDIR/etc to the PATH environment variable.
44In both cases, the command typed in at step 3. above would then reduce to:
45xlmake
46
47