README
author deba
Fri, 29 Sep 2006 11:25:27 +0000
changeset 2223 590c1b663a27
parent 2122 5b3737aa595a
child 2237 5674a5983e1e
permissions -rw-r--r--
Exporting interface to the Graph class
Some documentation improvements
alpar@2139
     1
------------------------------------------------------------------
alpar@2139
     2
LEMON - a Library of Efficient Models and Optimization in Networks
alpar@2139
     3
------------------------------------------------------------------
hegyi@2122
     4
alpar@2139
     5
LEMON is the abbreviation of Library of Efficient Models and
alpar@2139
     6
Optimization in Networks. It is an open source library written in
alpar@2139
     7
C++. It provides a set of easy-to-use implementation of common data
alpar@2139
     8
structures and algorithms in the area of optimization and helps
alpar@2139
     9
implementing new ones. It is an especially suitable tool to solve the
alpar@2139
    10
design and optimization problems of telecommunications networks. To
alpar@2139
    11
achieve wide usability, a fundamental design requirement is the
alpar@2139
    12
genericity of interface of data structures and algorithms. Lemon is
alpar@2139
    13
intended to become an open source library in order to involve people
alpar@2139
    14
all around the world in its development.
hegyi@2122
    15
alpar@2139
    16
--------
alpar@2139
    17
Contents
alpar@2139
    18
--------
hegyi@2122
    19
alpar@2139
    20
COPYING, LICENSE
hegyi@2122
    21
alpar@2139
    22
  Copying, distribution and modification conditions and terms.
hegyi@2122
    23
alpar@2139
    24
INSTALL
hegyi@2122
    25
alpar@2139
    26
  For general building and installation instructions, see the file
alpar@2139
    27
alpar@2139
    28
lemon/
alpar@2139
    29
alpar@2139
    30
  Source code of LEMON itself.
alpar@2139
    31
alpar@2139
    32
doc/
alpar@2139
    33
alpar@2139
    34
  Documentation of LEMON. The staring page is doc/html/index/html.
alpar@2139
    35
  The documentation will be installed into the directory
alpar@2139
    36
alpar@2139
    37
    /usr/local/share/doc/lemon/html
alpar@2139
    38
alpar@2139
    39
  or -- if you use different prefix -- into
alpar@2139
    40
alpar@2139
    41
    ${prefix}/share/doc/lemon/html
alpar@2139
    42
alpar@2139
    43
  (see also INSTALL).
alpar@2139
    44
alpar@2139
    45
demo/
alpar@2139
    46
alpar@2139
    47
  Some demonstration programs to make you easier to getting familiar
alpar@2139
    48
  with LEMON. Use --enable-demo configure option to also compile these
alpar@2139
    49
  codes (see also INSTALL).
alpar@2139
    50
alpar@2139
    51
test/
alpar@2139
    52
alpar@2139
    53
  Contains programs to check the integrity and correctness of
alpar@2139
    54
  LEMON. The command 'make check' performs these tests.
alpar@2139
    55
alpar@2139
    56
benchmark/
alpar@2139
    57
  
alpar@2139
    58
  Contains programs measuring the performance of LEMON. Use
alpar@2139
    59
  --enable-benchmark configure option to also compile these codes (see
alpar@2139
    60
  also INSTALL).