1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/doc/mainpage.dox.in Fri Mar 04 11:38:05 2011 +0100
1.3 @@ -0,0 +1,61 @@
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-2010
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 @PACKAGE_NAME@ @PACKAGE_VERSION@ Documentation
1.24 +
1.25 +\section intro Introduction
1.26 +
1.27 +<b>LEMON</b> stands for <i><b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling
1.28 +and <b>O</b>ptimization in <b>N</b>etworks</i>.
1.29 +It is a C++ template library providing efficient implementations of common
1.30 +data structures and algorithms with focus on combinatorial optimization
1.31 +tasks connected mainly with graphs and networks.
1.32 +
1.33 +<b>
1.34 +LEMON is an <a class="el" href="http://opensource.org/">open source</a>
1.35 +project.
1.36 +You are free to use it in your commercial or
1.37 +non-commercial applications under very permissive
1.38 +\ref license "license terms".
1.39 +</b>
1.40 +
1.41 +The project is maintained by the
1.42 +<a href="http://www.cs.elte.hu/egres/">Egerváry Research Group on
1.43 +Combinatorial Optimization</a> \ref egres
1.44 +at the Operations Research Department of the
1.45 +<a href="http://www.elte.hu/en/">Eötvös Loránd University</a>,
1.46 +Budapest, Hungary.
1.47 +LEMON is also a member of the <a href="http://www.coin-or.org/">COIN-OR</a>
1.48 +initiative \ref coinor.
1.49 +
1.50 +\section howtoread How to Read the Documentation
1.51 +
1.52 +If you would like to get to know the library, see
1.53 +<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
1.54 +
1.55 +If you are interested in starting to use the library, see the <a class="el"
1.56 +href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide/">Installation
1.57 +Guide</a>.
1.58 +
1.59 +If you know what you are looking for, then try to find it under the
1.60 +<a class="el" href="modules.html">Modules</a> section.
1.61 +
1.62 +If you are a user of the old (0.x) series of LEMON, please check out the
1.63 +\ref migration "Migration Guide" for the backward incompatibilities.
1.64 +*/