README
author Akos Ladanyi <ladanyi@tmit.bme.hu>
Wed, 23 Jan 2008 16:26:41 +0100
changeset 60 6ec5dbed8f18
parent 5 233b4094ceae
child 246 7c67988fca07
permissions -rw-r--r--
Reworked documentation generation and installation.
Details:
- Remove configure flag used to disable the automatic generation of the
documentation when istalling.
- Now 'make html' generates the documentation.
- Now 'make install' does not install the documentation, 'make install-html'
does that. The latter two changes follow newer automake conventions.
- This also fixes the bug that caused the documentation missing from the
tarball.
     1 ------------------------------------------------------------------
     2 LEMON - a Library of Efficient Models and Optimization in Networks
     3 ------------------------------------------------------------------
     4 
     5 LEMON is the abbreviation of Library of Efficient Models and
     6 Optimization in Networks. It is an open source library written in
     7 C++. It provides a set of easy-to-use implementation of common data
     8 structures and algorithms in the area of optimization and helps
     9 implementing new ones. It is an especially suitable tool to solve the
    10 design and optimization problems of telecommunications networks. To
    11 achieve wide usability, a fundamental design requirement is the
    12 genericity of interface of data structures and algorithms. LEMON is an
    13 open source library end invites people all around the world in its
    14 development.
    15 
    16 --------
    17 Contents
    18 --------
    19 
    20 COPYING, LICENSE
    21 
    22   Copying, distribution and modification conditions and terms.
    23 
    24 INSTALL
    25 
    26   For general building and installation instructions, see the file.
    27 
    28 lemon/
    29 
    30   Source code of LEMON itself.
    31 
    32 doc/
    33 
    34   Documentation of LEMON. The starting page is doc/html/index.html.
    35   The documentation installs into the directory
    36 
    37     /usr/local/share/doc/lemon/html
    38 
    39   or -- if you use different prefix -- into
    40 
    41     ${prefix}/share/doc/lemon/html
    42 
    43   (see also INSTALL).
    44 
    45 demo/
    46 
    47   Some demonstration programs to make you easier to get familiar with
    48   LEMON. Use --enable-demo configure option to also compile these codes
    49   (see also INSTALL).
    50 
    51 test/
    52 
    53   Contains programs to check the integrity and correctness of
    54   LEMON. The command 'make check' performs these tests.
    55 
    56 benchmark/
    57   
    58   Contains programs measuring the performance of LEMON. Use
    59   --enable-benchmark configure option to also compile these codes (see
    60   also INSTALL).