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