README
author Peter Kovacs <kpeter@inf.elte.hu>
Fri, 09 Jan 2009 12:54:27 +0100
changeset 474 fbd6e04acf44
parent 310 a9e8f310507f
child 705 ebdcc68fe79e
permissions -rw-r--r--
Various doc improvements for graph adaptors (#67)

- Add notes about modifying the adapted graphs through adaptors
if it is possible.
- Add notes about the possible conversions between the Node, Arc and
Edge types of the adapted graphs and the adaptors.
- Hide the default values for template parameters (describe them
in the doc instead).
- More precise docs for template parameters.
- More precise docs for member functions.
- Add docs for important public typedefs.
- Unify the docs of the adaptors.
- Add \relates commands for the creator functions.
- Fixes and improvements the module documentation.
     1 ==================================================================
     2 LEMON - a Library of Efficient Models and Optimization in Networks
     3 ==================================================================
     4 
     5 LEMON is an open source library written in C++. It provides
     6 easy-to-use implementations of common data structures and algorithms
     7 in the area of optimization and helps implementing new ones. The main
     8 focus is on graphs and graph algorithms, thus it is especially
     9 suitable for solving design and optimization problems of
    10 telecommunication networks. To achieve wide usability its data
    11 structures and algorithms provide generic interfaces.
    12 
    13 Contents
    14 ========
    15 
    16 LICENSE
    17 
    18    Copying, distribution and modification conditions and terms.
    19 
    20 INSTALL
    21 
    22    General building and installation instructions.
    23 
    24 lemon/
    25 
    26    Source code of LEMON library.
    27 
    28 doc/
    29 
    30    Documentation of LEMON. The starting page is doc/html/index.html.
    31 
    32 demo/
    33 
    34    Some example programs to make you easier to get familiar with LEMON.
    35 
    36 test/
    37 
    38    Programs to check the integrity and correctness of LEMON.
    39 
    40 tools/
    41 
    42    Various utilities related to LEMON.