intro.dox
changeset 3 0cf8882c7e7c
child 6 da96f28684f7
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/intro.dox	Sat Oct 11 13:13:09 2008 +0200
     1.3 @@ -0,0 +1,45 @@
     1.4 +/* -*- mode: C++; indent-tabs-mode: nil; -*-
     1.5 + *
     1.6 + * This file is a part of LEMON, a generic C++ optimization library.
     1.7 + *
     1.8 + * Copyright (C) 2003-2008
     1.9 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    1.10 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
    1.11 + *
    1.12 + * Permission to use, modify and distribute this software is granted
    1.13 + * provided that this copyright notice appears in all copies. For
    1.14 + * precise terms see the accompanying LICENSE file.
    1.15 + *
    1.16 + * This software is provided "AS IS" with no warranty of any kind,
    1.17 + * express or implied, and with no claim as to its suitability for any
    1.18 + * purpose.
    1.19 + *
    1.20 + */
    1.21 +
    1.22 +/**
    1.23 +\page intro Introduction
    1.24 +
    1.25 +\section intro_lemon What is LEMON
    1.26 +
    1.27 +LEMON stands for <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels and
    1.28 +<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
    1.29 +library aimed at combinatorial optimization tasks which often involve
    1.30 +in working with graphs.
    1.31 +
    1.32 +<b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    1.33 +project.
    1.34 +You are free to use it in your commercial or non-commercial applications
    1.35 +under very permissive \ref license "license terms".
    1.36 +</b>
    1.37 +
    1.38 +\section intro_tutorial LEMON Tutorial
    1.39 +
    1.40 +This tutorial introduces the reader to the basic concepts and features of
    1.41 +LEMON, and there are some sections about advanced topics showing the power
    1.42 +of the various tools implemented in the library.
    1.43 +
    1.44 +After getting familiar with the basic concepts you may start using LEMON
    1.45 +with the help of the detailed documentation (that can also be used as a
    1.46 +reference manual).
    1.47 +
    1.48 +*/