Changeset 666:410a1419e86b in lemon-0.x for doc

Timestamp:

05/28/04 09:48:16 (20 years ago)

Author:

Akos Ladanyi

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@877

Message:

Added a short tutorial on using graphs.

Location:

doc

Files:

• Doxyfile (modified) (1 diff)
• graphs.dox (added)
• mainpage.dox (modified) (1 diff)

doc/Doxyfile

@@ -393 +393 @@
 
 INPUT                  = mainpage.dox \
+                         graphs.dox \
                          maps.dox coding_style.dox \
                          groups.dox \

doc/mainpage.dox

@@ -2 +2 @@
 \mainpage
 
-Please make a better mainpage (doc/mainpage.dox).
+\section intro Introduction
+
+\subsection whatis What is HugoLib
+
+HugoLib stands for Hungarian Graph Optimization Library. It is a C++ template
+library aimed at combinatorial optimization tasks which often involve working
+with graphs. As the name also suggests, its development was started by
+Hungarian people.
+
+\subsection howtoread How to read this document
+
+If you are new to HugoLib, you probably should start \ref graphs "here".
+You can also find this page along with other under Related Pages (left-hand
+side frame).
+
+If you are more interested in details about data structures and algorithms then
+you should browse the reference manual part of the documentation. The Modules
+section is a good starting point for this.
 
 */