1 LEMON  | 
     1 ------------------------------------------------------------------  | 
         | 
     2 LEMON - a Library of Efficient Models and Optimization in Networks  | 
         | 
     3 ------------------------------------------------------------------  | 
     2   | 
     4   | 
     3 Library of Efficient Models and Optimization in Networks  | 
     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  | 
         | 
    13 intended to become an open source library in order to involve people  | 
         | 
    14 all around the world in its development.  | 
     4   | 
    15   | 
     5 LEMON is the abbreviation of Library of Efficient Models  | 
    16 --------  | 
     6 and Optimization in Networks. It is an open source  | 
    17 Contents  | 
     7 library written in C++. It provides a set of easy-to-use  | 
    18 --------  | 
     8 implementation of common data structures and algorithms  | 
         | 
     9 in the area of optimization and helps implementing new  | 
         | 
    10 ones. It is an especially suitable tool to solve the  | 
         | 
    11 design and optimization problems of telecommunications  | 
         | 
    12 networks. To achieve wide usability, a fundamental design  | 
         | 
    13 requirement is the genericity of interface of data  | 
         | 
    14 structures and algorithms. Lemon is intended to become an  | 
         | 
    15 open source library in order to involve people all around  | 
         | 
    16 the world in its development.  | 
         | 
    17   | 
    19   | 
    18 The subdirectories 'autopackage', 'build-aux' and 'm4' are  | 
    20 COPYING, LICENSE  | 
    19 needed by installation. In subdirectory 'benchmark'  | 
         | 
    20 programs can be found that observe the performance of LEMON.  | 
         | 
    21 Subdirectory 'demo' contains some demonstration programs to  | 
         | 
    22 make you easier to getting familiar with LEMON. Documentation  | 
         | 
    23 of LEMON can be found in subdirectory 'doc'. Source code of  | 
         | 
    24 LEMON is in subdirectory 'lemon'. Some useful scripts related  | 
         | 
    25 to the usage of LEMON can be found in subdirectory 'scripts'.  | 
         | 
    26 In subdirectory 'test' you can find some programs, proofing  | 
         | 
    27 you the correctness of some implementations.  | 
         | 
    28   | 
    21   | 
    29 See file COPYING for copying, distribution and modification  | 
    22   Copying, distribution and modification conditions and terms.  | 
    30 conditions and terms.  | 
         | 
    31   | 
    23   | 
    32 For general building and installation instructions, see the  | 
    24 INSTALL  | 
    33 file INSTALL.  | 
         | 
    34   | 
    25   | 
    35 Version number of the package is the highest one written in  | 
    26   For general building and installation instructions, see the file  | 
    36 file NEWS.  | 
    27   | 
         | 
    28 lemon/  | 
         | 
    29   | 
         | 
    30   Source code of LEMON itself.  | 
         | 
    31   | 
         | 
    32 doc/  | 
         | 
    33   | 
         | 
    34   Documentation of LEMON. The staring page is doc/html/index/html.  | 
         | 
    35   The documentation will be installed 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 getting familiar  | 
         | 
    48   with LEMON. Use --enable-demo configure option to also compile these  | 
         | 
    49   codes (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).  |