doc/mainpage.dox
author alpar
Mon, 04 Sep 2006 19:12:44 +0000
changeset 2194 eaf16c8f6fef
parent 1173 099978eee03f
child 2391 14a343be7a5a
permissions -rw-r--r--
'make doc' is now working also in case of external build.
     1 /**
     2 \mainpage LEMON Documentation
     3 
     4 \section intro Introduction
     5 
     6 \subsection whatis What is LEMON
     7 
     8 LEMON stands for
     9 <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
    10 and <b>O</b>ptimization in <b>N</b>etworks.
    11 It is a C++ template
    12 library aimed at combinatorial optimization tasks which
    13 often involve in working
    14 with graphs.
    15 
    16 <b>
    17 LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    18 project.
    19 You are free to use it in your commercial or
    20 non-commercial applications under very permissive
    21 \ref license "license terms".
    22 </b>
    23 
    24 \subsection howtoread How to read the documentation
    25 
    26 If you want to get a quick start and see the most important features then 
    27 take a look at our \ref quicktour
    28 "Quick Tour to LEMON" which will guide you along.
    29 
    30 If you already feel like using our library, see the page that tells you 
    31 \ref getstart "How to start using LEMON".
    32 
    33 If you 
    34 want to see how LEMON works, see 
    35 some \ref demoprograms "demo programs"!
    36 
    37 If you know what you are looking for then try to find it under the
    38 <a class="el" href="modules.html">Modules</a>
    39 section.
    40 
    41 
    42 */