doc/mainpage.dox
author athos
Fri, 01 Jul 2005 16:10:46 +0000
changeset 1528 1aa71600000c
parent 1170 fb0159aa582d
child 2141 9bb0bfea2f0b
permissions -rw-r--r--
Graph input-output demo, some documentation.
alpar@479
     1
/**
alpar@995
     2
\mainpage LEMON Documentation
alpar@479
     3
ladanyi@666
     4
\section intro Introduction
alpar@479
     5
alpar@921
     6
\subsection whatis What is LEMON
ladanyi@666
     7
alpar@921
     8
LEMON stands for
alpar@926
     9
<b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
alpar@926
    10
and <b>O</b>ptimization in <b>N</b>etworks.
alpar@670
    11
It is a C++ template
alpar@670
    12
library aimed at combinatorial optimization tasks which
alpar@1170
    13
often involve in working
alpar@991
    14
with graphs.
alpar@991
    15
alpar@991
    16
<b>
alpar@995
    17
LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
alpar@995
    18
project.
marci@1003
    19
You are free to use it in your commercial or
marci@1003
    20
non-commercial applications under very permissive
alpar@991
    21
\ref license "license terms".
alpar@991
    22
</b>
ladanyi@666
    23
athos@1169
    24
\subsection howtoread How to read the documentation
ladanyi@666
    25
athos@1169
    26
If you want to get a quick start and see the most important features then 
athos@1169
    27
take a look at our \ref quicktour
athos@1169
    28
"Quick Tour to LEMON" which will guide you along.
ladanyi@666
    29
athos@1173
    30
If you already feel like using our library, see the page that tells you 
athos@1173
    31
\ref getstart "How to start using LEMON".
athos@1173
    32
athos@1169
    33
If you 
athos@1169
    34
want to see how LEMON works, see 
alpar@1170
    35
some \ref demoprograms "demo programs"!
athos@1169
    36
athos@1169
    37
If you know what you are looking for then try to find it in the index or 
athos@1169
    38
in the table of contents.
athos@1169
    39
ladanyi@666
    40
ladanyi@666
    41
*/