README
author Peter Kovacs <kpeter@inf.elte.hu>
Thu, 09 Oct 2008 13:27:35 +0200
changeset 314 2cc60866a0c9
parent 24 1f781d1f9b79
child 310 a9e8f310507f
permissions -rw-r--r--
Doc reorganization + improvements

- Reorganize several tools (move them to other modules).
- Add new module for map concepts.
- Remove the doc of all tools in lemon/bits.
- Improvements in groups.dox.
- Fix some doxygen warnings.
alpar@246
     1
==================================================================
alpar@5
     2
LEMON - a Library of Efficient Models and Optimization in Networks
alpar@246
     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
alpar@5
    20
INSTALL
alpar@5
    21
alpar@246
    22
   General building and installation instructions.
alpar@5
    23
alpar@5
    24
lemon/
alpar@5
    25
alpar@246
    26
   Source code of LEMON library.
alpar@5
    27
alpar@5
    28
doc/
alpar@5
    29
alpar@246
    30
   Documentation of LEMON. The starting page is doc/html/index.html.
alpar@5
    31
alpar@5
    32
demo/
alpar@5
    33
alpar@246
    34
   Some example programs to make you easier to get familiar with LEMON.
alpar@5
    35
alpar@5
    36
test/
alpar@5
    37
alpar@246
    38
   Contains programs to check the integrity and correctness of LEMON.
alpar@5
    39
alpar@5
    40
benchmark/
alpar@5
    41
  
alpar@246
    42
   Contains programs for measuring the performance of algorithms.
alpar@246
    43
alpar@246
    44
tools/
alpar@246
    45
alpar@246
    46
   Various utilities related to LEMON.