Changeset 1514:c9b9bc63db4e in lemon-0.x for doc/getstart.dox

Timestamp:

06/24/05 23:03:08 (18 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Improved getsart.dox and quicktour.dox

File:

• doc/getstart.dox (modified) (9 diffs)

doc/getstart.dox

@@ -4 +4 @@
 In this page we detail how to start using LEMON, from downloading it to 
 your computer, through the steps of installation to showing a simple
-"Hello World" type program that already uses LEMON. If anything is not 
+"Hello World" type program that already uses LEMON. We assume that you have a
+basic knowledge of your operating system and \c C++ or \c C 
+programming language. If anything is not 
 clear write to our FAQ.
 
@@ -10 +12 @@
 twice YES then a link comes here.
 
+\section requirementsLEMON Hardware and software requirements
 
+Hardware requirements ...
+
+You will also need a C++ compiler. We mostly used the Gnu C++ Compiler (g++),
+from version 3.0 upwards. We also checked the Intel C compiler
+(icc). Unfortunately, Visual C++ compiler knows not enough to compile the
+library, so if you are using Microsoft Windows, then try to compile under
+Cygwin. 
+
+Ide kell írni:
+ 
+-Hol fordul (Windows-os fordító nem fordítja, unix/linux alatt gcc hanyas verziója kell)
+-
+
+In this description we will suppose a linux environment and Gnu C Compiler.
 
 \section downloadLEMON How to download LEMON
@@ -16 +33 @@
 You can download LEMON from the LEMON web site:
 http://lemon.cs.elte.hu
-by following the download link. There you will find the issued distributions in form of \e .ta.gz files. If you want a developer version  (for example you want to contribute in developing the library LEMON) then you might want to use our Subversion repository. This case is not detailed here, so from now on we suppose that you downloaded a tar.gz file.
+by following the download link. There you will find the issued distributions
+in form of <tt> .tar.gz </tt> files. If you want a developer version  (for example you want to contribute in developing the library LEMON) then you might want to use our Subversion repository. This case is not detailed here, so from now on we suppose that you downloaded a tar.gz file.
+
 
 
@@ -23 +42 @@
 In order to install LEMON you have to do the following
 
-Download the tarball and issue the following commands:
+Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y and \c z are
+numbers indicating the version of the library: in our example we will have lemon-0.3.1) and issue the following commands:
 
 \code
@@ -34 +54 @@
 \endcode
 
-These commands install LEMON under /usr/local. If you want to install it to some other place, then pass the --prefix=DIR flag to ./configure.
+These commands install LEMON under \c /usr/local (you will probably need \c root
+privileges to be able to install to that directory). If you want to install it
+to some other place, then pass the \c --prefix=DIR flag to \c ./configure. In
+what follows we will assume that you were able to install to directory \c
+/usr/local, otherwise some extra care is to be taken to use the library.
 
-Ide kell írni:
- 
--Hol fordul (Windows-os fordító nem fordítja, unix/linux alatt gcc hanyas verziója kell)
--
+We briefly explain these commands below.
+
+\code
+tar xvzf lemon-0.3.1.tar.gz
+\endcode
+This command untars the <tt>tar.gz</tt> file into a directory named <tt> lemon-0.3.1</tt>.
+
+\code
+cd lemon-0.3.1
+\endcode
+Enters the directory.
+
+\code
+./configure
+\endcode
+Does some configuration (creates makefiles etc).
+
+\code
+make
+\endcode
+This command compiles the <tt> .cc</tt> files of the library package (the
+implementation of non-template functions and classes and some test and demo
+programs) and creates the very important <b> libemon.la </b> file. When
+linking your program that uses LEMON it needs to access this file.
+
+\code
+make check (This is optional, but recomended. It runs a bunch of tests.)
+\endcode
+This is an optional step: it runs the test programs that we developed for
+LEMON to check
+whether the library works properly on your platform.
+
+\code
+make install
+\endcode
+This will copy the directory structure to its final destination (e.g. to \c
+/usr/local) so that your system can access it.
 
 \section helloworld My first program using LEMON
 
-If you have installed LEMON on your system you can paste the following code
+If you have installed LEMON on your system you 
+can paste the following code
 segment into a file to have a first working program that uses library LEMON.
 
@@ -55 +113 @@
 {
   typedef ListGraph Graph;
-  typedef Graph::Edge Edge;
-  typedef Graph::InEdgeIt InEdgeIt;
-  typedef Graph::OutEdgeIt OutEdgeIt;
   typedef Graph::EdgeIt EdgeIt;
-  typedef Graph::Node Node;
   typedef Graph::NodeIt NodeIt;
 
@@ -83 +137 @@
 \endcode
 
+First let us briefly explain how this program works.
 
 ListGraph is one of LEMON's graph classes. It is based on linked lists,
@@ -100 +155 @@
 \c source member functions can be used to access the endpoints of an edge.
 
-The previous code fragment prints out the following:
+If you have saved the preceding code into a file named, say,  \c hemon.cc and your installation of LEMON into directory \c /usr/local was
+successful then it is very easy to compile this program with the following
+command (the argument <tt>-lemon</tt> tells the compiler that we are using the
+installed library LEMON):
+\code
+g++ hemon.cc -o hemon -lemon
+\endcode
+
+As a result you will get the exacutable \c hemon in
+this directory that you can run by the command 
+\code
+./hemon
+\endcode
+
+
+If everything has gone well then the previous code fragment prints out the following:
 
 \code
@@ -108 +178 @@
 \endcode
 
+Congratulations!
 
 If you want to see more features, go to the \ref quicktour "Quick Tour to