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
     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-2008
     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 \page intro Introduction
    21 
    22 \section intro_lemon What is LEMON
    23 
    24 LEMON stands for <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels and
    25 <b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
    26 library aimed at combinatorial optimization tasks which often involve
    27 in working with graphs.
    28 
    29 <b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    30 project.
    31 You are free to use it in your commercial or non-commercial applications
    32 under very permissive \ref license "license terms".
    33 </b>
    34 
    35 \section intro_tutorial LEMON Tutorial
    36 
    37 This tutorial introduces the reader to the basic concepts and features of
    38 LEMON, and there are some sections about advanced topics showing the power
    39 of the various tools implemented in the library.
    40 
    41 After getting familiar with the basic concepts you may start using LEMON
    42 with the help of the detailed documentation (that can also be used as a
    43 reference manual).
    44 
    45 */