diff options
author | Carlo Zancanaro <carlo@pc-4w14-0.cs.usyd.edu.au> | 2012-07-10 13:44:21 +1000 |
---|---|---|
committer | Carlo Zancanaro <carlo@pc-4w14-0.cs.usyd.edu.au> | 2012-07-10 13:44:21 +1000 |
commit | ef4a319984d22b88a9024ff523700d657621124d (patch) | |
tree | 2821db78ccd6ce61ca64ad6fc98ba825b060ca6a /lemon/doc/mainpage.dox.in | |
parent | d3f13fdd23e17a8f4bb4083c24fee331a28351eb (diff) |
Add the LEMON graph library source to the repo
I'll likely be using it, so this just makes it easier to get to from
elsewhere. If I end up not using it then I can just delete it.
Diffstat (limited to 'lemon/doc/mainpage.dox.in')
-rw-r--r-- | lemon/doc/mainpage.dox.in | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/lemon/doc/mainpage.dox.in b/lemon/doc/mainpage.dox.in new file mode 100644 index 0000000..86f124d --- /dev/null +++ b/lemon/doc/mainpage.dox.in @@ -0,0 +1,61 @@ +/* -*- mode: C++; indent-tabs-mode: nil; -*- + * + * This file is a part of LEMON, a generic C++ optimization library. + * + * Copyright (C) 2003-2010 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport + * (Egervary Research Group on Combinatorial Optimization, EGRES). + * + * Permission to use, modify and distribute this software is granted + * provided that this copyright notice appears in all copies. For + * precise terms see the accompanying LICENSE file. + * + * This software is provided "AS IS" with no warranty of any kind, + * express or implied, and with no claim as to its suitability for any + * purpose. + * + */ + +/** +\mainpage @PACKAGE_NAME@ @PACKAGE_VERSION@ Documentation + +\section intro Introduction + +<b>LEMON</b> stands for <i><b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling +and <b>O</b>ptimization in <b>N</b>etworks</i>. +It is a C++ template library providing efficient implementations of common +data structures and algorithms with focus on combinatorial optimization +tasks connected mainly with graphs and networks. + +<b> +LEMON is an <a class="el" href="http://opensource.org/">open source</a> +project. +You are free to use it in your commercial or +non-commercial applications under very permissive +\ref license "license terms". +</b> + +The project is maintained by the +<a href="http://www.cs.elte.hu/egres/">Egerváry Research Group on +Combinatorial Optimization</a> \ref egres +at the Operations Research Department of the +<a href="http://www.elte.hu/en/">Eötvös Loránd University</a>, +Budapest, Hungary. +LEMON is also a member of the <a href="http://www.coin-or.org/">COIN-OR</a> +initiative \ref coinor. + +\section howtoread How to Read the Documentation + +If you would like to get to know the library, see +<a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>. + +If you are interested in starting to use the library, see the <a class="el" +href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide/">Installation +Guide</a>. + +If you know what you are looking for, then try to find it under the +<a class="el" href="modules.html">Modules</a> section. + +If you are a user of the old (0.x) series of LEMON, please check out the +\ref migration "Migration Guide" for the backward incompatibilities. +*/ |