README
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 07 Oct 2017 00:19:19 +0200
changeset 1377 7d32a2d6ed59
parent 705 ebdcc68fe79e
permissions -rw-r--r--
Change the style of code examples in API doc
kpeter@705
     1
=====================================================================
kpeter@705
     2
LEMON - a Library for Efficient Modeling and Optimization in Networks
kpeter@705
     3
=====================================================================
alpar@5
     4
alpar@246
     5
LEMON is an open source library written in C++. It provides
alpar@246
     6
easy-to-use implementations of common data structures and algorithms
alpar@246
     7
in the area of optimization and helps implementing new ones. The main
alpar@246
     8
focus is on graphs and graph algorithms, thus it is especially
alpar@246
     9
suitable for solving design and optimization problems of
alpar@246
    10
telecommunication networks. To achieve wide usability its data
alpar@246
    11
structures and algorithms provide generic interfaces.
alpar@5
    12
alpar@5
    13
Contents
alpar@246
    14
========
alpar@5
    15
alpar@246
    16
LICENSE
alpar@5
    17
alpar@246
    18
   Copying, distribution and modification conditions and terms.
alpar@5
    19
kpeter@921
    20
NEWS
kpeter@921
    21
kpeter@921
    22
   News and version history.
kpeter@921
    23
alpar@5
    24
INSTALL
alpar@5
    25
alpar@246
    26
   General building and installation instructions.
alpar@5
    27
alpar@5
    28
lemon/
alpar@5
    29
alpar@246
    30
   Source code of LEMON library.
alpar@5
    31
alpar@5
    32
doc/
alpar@5
    33
alpar@246
    34
   Documentation of LEMON. The starting page is doc/html/index.html.
alpar@5
    35
alpar@5
    36
demo/
alpar@5
    37
alpar@246
    38
   Some example programs to make you easier to get familiar with LEMON.
alpar@5
    39
kpeter@921
    40
scripts/
kpeter@921
    41
kpeter@921
    42
   Scripts that make it easier to develop LEMON.
kpeter@921
    43
alpar@5
    44
test/
alpar@5
    45
kpeter@318
    46
   Programs to check the integrity and correctness of LEMON.
alpar@5
    47
alpar@246
    48
tools/
alpar@246
    49
alpar@246
    50
   Various utilities related to LEMON.