doc/mainpage.dox
author Akos Ladanyi <ladanyi@tmit.bme.hu>
Tue, 28 Apr 2009 14:47:25 +0100
changeset 634 4629e096e3af
parent 440 88ed40ad0d4f
child 651 3adf5e2d1e62
permissions -rw-r--r--
Look for COIN libraries with and without the lib prefix too (#277)

This is necessary because on Windows when built using autotools the COIN
libraries are named in UNIX style, i.e. libCbc.lib insetad of Cbc.lib.
alpar@209
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@40
     2
 *
alpar@209
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@40
     4
 *
alpar@440
     5
 * Copyright (C) 2003-2009
alpar@40
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@40
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@40
     8
 *
alpar@40
     9
 * Permission to use, modify and distribute this software is granted
alpar@40
    10
 * provided that this copyright notice appears in all copies. For
alpar@40
    11
 * precise terms see the accompanying LICENSE file.
alpar@40
    12
 *
alpar@40
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@40
    14
 * express or implied, and with no claim as to its suitability for any
alpar@40
    15
 * purpose.
alpar@40
    16
 *
alpar@40
    17
 */
alpar@40
    18
alpar@40
    19
/**
alpar@40
    20
\mainpage LEMON Documentation
alpar@40
    21
alpar@40
    22
\section intro Introduction
alpar@40
    23
alpar@40
    24
\subsection whatis What is LEMON
alpar@40
    25
alpar@40
    26
LEMON stands for
alpar@40
    27
<b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
alpar@40
    28
and <b>O</b>ptimization in <b>N</b>etworks.
alpar@40
    29
It is a C++ template
alpar@40
    30
library aimed at combinatorial optimization tasks which
alpar@40
    31
often involve in working
alpar@40
    32
with graphs.
alpar@40
    33
alpar@40
    34
<b>
alpar@40
    35
LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
alpar@40
    36
project.
alpar@40
    37
You are free to use it in your commercial or
alpar@40
    38
non-commercial applications under very permissive
alpar@40
    39
\ref license "license terms".
alpar@40
    40
</b>
alpar@40
    41
alpar@40
    42
\subsection howtoread How to read the documentation
alpar@40
    43
alpar@209
    44
If you want to get a quick start and see the most important features then
alpar@40
    45
take a look at our \ref quicktour
alpar@40
    46
"Quick Tour to LEMON" which will guide you along.
alpar@40
    47
kpeter@559
    48
If you already feel like using our library, see the
kpeter@559
    49
<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
alpar@40
    50
alpar@40
    51
If you know what you are looking for then try to find it under the
kpeter@559
    52
<a class="el" href="modules.html">Modules</a> section.
alpar@40
    53
kpeter@314
    54
If you are a user of the old (0.x) series of LEMON, please check out the
kpeter@314
    55
\ref migration "Migration Guide" for the backward incompatibilities.
alpar@40
    56
*/