doc/mainpage.dox.in
changeset 1037 d3b041452dd8
parent 705 ebdcc68fe79e
child 1039 7f37e5fc416e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/mainpage.dox.in	Fri Mar 04 10:31:12 2011 +0100
     1.3 @@ -0,0 +1,51 @@
     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-2009
     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 +\subsection whatis What is LEMON
    1.28 +
    1.29 +LEMON stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling
    1.30 +and <b>O</b>ptimization in <b>N</b>etworks.
    1.31 +It is a C++ template
    1.32 +library aimed at combinatorial optimization tasks which
    1.33 +often involve in working
    1.34 +with graphs.
    1.35 +
    1.36 +<b>
    1.37 +LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    1.38 +project.
    1.39 +You are free to use it in your commercial or
    1.40 +non-commercial applications under very permissive
    1.41 +\ref license "license terms".
    1.42 +</b>
    1.43 +
    1.44 +\subsection howtoread How to read the documentation
    1.45 +
    1.46 +If you would like to get to know the library, see
    1.47 +<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
    1.48 +
    1.49 +If you know what you are looking for, then try to find it under the
    1.50 +<a class="el" href="modules.html">Modules</a> section.
    1.51 +
    1.52 +If you are a user of the old (0.x) series of LEMON, please check out the
    1.53 +\ref migration "Migration Guide" for the backward incompatibilities.
    1.54 +*/