doc/mainpage.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Thu, 07 May 2009 02:07:59 +0200
changeset 698 3adf5e2d1e62
parent 606 c5fd2d996909
child 705 ebdcc68fe79e
permissions -rw-r--r--
Small doc improvements (#257)
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2009
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 /**
    20 \mainpage LEMON Documentation
    21 
    22 \section intro Introduction
    23 
    24 \subsection whatis What is LEMON
    25 
    26 LEMON stands for
    27 <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
    28 and <b>O</b>ptimization in <b>N</b>etworks.
    29 It is a C++ template
    30 library aimed at combinatorial optimization tasks which
    31 often involve in working
    32 with graphs.
    33 
    34 <b>
    35 LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    36 project.
    37 You are free to use it in your commercial or
    38 non-commercial applications under very permissive
    39 \ref license "license terms".
    40 </b>
    41 
    42 \subsection howtoread How to read the documentation
    43 
    44 If you would like to get to know the library, see
    45 <a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
    46 
    47 If you know what you are looking for, then try to find it under the
    48 <a class="el" href="modules.html">Modules</a> section.
    49 
    50 If you are a user of the old (0.x) series of LEMON, please check out the
    51 \ref migration "Migration Guide" for the backward incompatibilities.
    52 */