1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/mainpage.dox	Mon Jan 07 19:22:09 2008 +0100
     1.3 @@ -0,0 +1,60 @@
     1.4 +/* -*- C++ -*-
     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 +\mainpage LEMON Documentation
    1.24 +
    1.25 +\section intro Introduction
    1.26 +
    1.27 +\subsection whatis What is LEMON
    1.28 +
    1.29 +LEMON stands for
    1.30 +<b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels
    1.31 +and <b>O</b>ptimization in <b>N</b>etworks.
    1.32 +It is a C++ template
    1.33 +library aimed at combinatorial optimization tasks which
    1.34 +often involve in working
    1.35 +with graphs.
    1.36 +
    1.37 +<b>
    1.38 +LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    1.39 +project.
    1.40 +You are free to use it in your commercial or
    1.41 +non-commercial applications under very permissive
    1.42 +\ref license "license terms".
    1.43 +</b>
    1.44 +
    1.45 +\subsection howtoread How to read the documentation
    1.46 +
    1.47 +If you want to get a quick start and see the most important features then 
    1.48 +take a look at our \ref quicktour
    1.49 +"Quick Tour to LEMON" which will guide you along.
    1.50 +
    1.51 +If you already feel like using our library, see the page that tells you 
    1.52 +\ref getstart "How to start using LEMON".
    1.53 +
    1.54 +If you 
    1.55 +want to see how LEMON works, see 
    1.56 +some \ref demoprograms "demo programs"!
    1.57 +
    1.58 +If you know what you are looking for then try to find it under the
    1.59 +<a class="el" href="modules.html">Modules</a>
    1.60 +section.
    1.61 +
    1.62 +
    1.63 +*/