intro.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 11 Oct 2008 13:13:09 +0200
changeset 3 0cf8882c7e7c
child 6 da96f28684f7
permissions -rw-r--r--
Add Intro and Getting Started pages
kpeter@3
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@3
     2
 *
kpeter@3
     3
 * This file is a part of LEMON, a generic C++ optimization library.
kpeter@3
     4
 *
kpeter@3
     5
 * Copyright (C) 2003-2008
kpeter@3
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@3
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@3
     8
 *
kpeter@3
     9
 * Permission to use, modify and distribute this software is granted
kpeter@3
    10
 * provided that this copyright notice appears in all copies. For
kpeter@3
    11
 * precise terms see the accompanying LICENSE file.
kpeter@3
    12
 *
kpeter@3
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@3
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@3
    15
 * purpose.
kpeter@3
    16
 *
kpeter@3
    17
 */
kpeter@3
    18
kpeter@3
    19
/**
kpeter@3
    20
\page intro Introduction
kpeter@3
    21
kpeter@3
    22
\section intro_lemon What is LEMON
kpeter@3
    23
kpeter@3
    24
LEMON stands for <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels and
kpeter@3
    25
<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
kpeter@3
    26
library aimed at combinatorial optimization tasks which often involve
kpeter@3
    27
in working with graphs.
kpeter@3
    28
kpeter@3
    29
<b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
kpeter@3
    30
project.
kpeter@3
    31
You are free to use it in your commercial or non-commercial applications
kpeter@3
    32
under very permissive \ref license "license terms".
kpeter@3
    33
</b>
kpeter@3
    34
kpeter@3
    35
\section intro_tutorial LEMON Tutorial
kpeter@3
    36
kpeter@3
    37
This tutorial introduces the reader to the basic concepts and features of
kpeter@3
    38
LEMON, and there are some sections about advanced topics showing the power
kpeter@3
    39
of the various tools implemented in the library.
kpeter@3
    40
kpeter@3
    41
After getting familiar with the basic concepts you may start using LEMON
kpeter@3
    42
with the help of the detailed documentation (that can also be used as a
kpeter@3
    43
reference manual).
kpeter@3
    44
kpeter@3
    45
*/