doc/mainpage.dox
changeset 666 410a1419e86b
parent 479 82b7894bed0c
child 670 e45bf7830d8c
     1.1 --- a/doc/mainpage.dox	Thu May 27 10:04:55 2004 +0000
     1.2 +++ b/doc/mainpage.dox	Fri May 28 07:48:16 2004 +0000
     1.3 @@ -1,6 +1,23 @@
     1.4  /**
     1.5  \mainpage
     1.6  
     1.7 -Please make a better mainpage (doc/mainpage.dox).
     1.8 +\section intro Introduction
     1.9  
    1.10 -*/
    1.11 \ No newline at end of file
    1.12 +\subsection whatis What is HugoLib
    1.13 +
    1.14 +HugoLib stands for Hungarian Graph Optimization Library. It is a C++ template
    1.15 +library aimed at combinatorial optimization tasks which often involve working
    1.16 +with graphs. As the name also suggests, its development was started by
    1.17 +Hungarian people.
    1.18 +
    1.19 +\subsection howtoread How to read this document
    1.20 +
    1.21 +If you are new to HugoLib, you probably should start \ref graphs "here".
    1.22 +You can also find this page along with other under Related Pages (left-hand
    1.23 +side frame).
    1.24 +
    1.25 +If you are more interested in details about data structures and algorithms then
    1.26 +you should browse the reference manual part of the documentation. The Modules
    1.27 +section is a good starting point for this.
    1.28 +
    1.29 +*/