README
changeset 246 7c67988fca07
parent 24 1f781d1f9b79
child 310 a9e8f310507f
equal deleted inserted replaced
1:bc6eb7916385 2:cf4b72d1b8f1
     1 ------------------------------------------------------------------
     1 ==================================================================
     2 LEMON - a Library of Efficient Models and Optimization in Networks
     2 LEMON - a Library of Efficient Models and Optimization in Networks
     3 ------------------------------------------------------------------
     3 ==================================================================
     4 
     4 
     5 LEMON is the abbreviation of Library of Efficient Models and
     5 LEMON is an open source library written in C++. It provides
     6 Optimization in Networks. It is an open source library written in
     6 easy-to-use implementations of common data structures and algorithms
     7 C++. It provides a set of easy-to-use implementation of common data
     7 in the area of optimization and helps implementing new ones. The main
     8 structures and algorithms in the area of optimization and helps
     8 focus is on graphs and graph algorithms, thus it is especially
     9 implementing new ones. It is an especially suitable tool to solve the
     9 suitable for solving design and optimization problems of
    10 design and optimization problems of telecommunications networks. To
    10 telecommunication networks. To achieve wide usability its data
    11 achieve wide usability, a fundamental design requirement is the
    11 structures and algorithms provide generic interfaces.
    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 
    12 
    16 --------
       
    17 Contents
    13 Contents
    18 --------
    14 ========
    19 
    15 
    20 COPYING, LICENSE
    16 LICENSE
    21 
    17 
    22   Copying, distribution and modification conditions and terms.
    18    Copying, distribution and modification conditions and terms.
    23 
    19 
    24 INSTALL
    20 INSTALL
    25 
    21 
    26   For general building and installation instructions, see the file.
    22    General building and installation instructions.
    27 
    23 
    28 lemon/
    24 lemon/
    29 
    25 
    30   Source code of LEMON itself.
    26    Source code of LEMON library.
    31 
    27 
    32 doc/
    28 doc/
    33 
    29 
    34   Documentation of LEMON. The starting page is doc/html/index.html.
    30    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 
    31 
    45 demo/
    32 demo/
    46 
    33 
    47   Some demonstration programs to make you easier to get familiar with
    34    Some example programs to make you easier to get familiar with LEMON.
    48   LEMON. Use --enable-demo configure option to also compile these codes
       
    49   (see also INSTALL).
       
    50 
    35 
    51 test/
    36 test/
    52 
    37 
    53   Contains programs to check the integrity and correctness of
    38    Contains programs to check the integrity and correctness of LEMON.
    54   LEMON. The command 'make check' performs these tests.
       
    55 
    39 
    56 benchmark/
    40 benchmark/
    57   
    41   
    58   Contains programs measuring the performance of LEMON. Use
    42    Contains programs for measuring the performance of algorithms.
    59   --enable-benchmark configure option to also compile these codes (see
    43 
    60   also INSTALL).
    44 tools/
       
    45 
       
    46    Various utilities related to LEMON.