Changeset 1519:17e367a93cbb in lemon-0.x for doc/getstart.dox

Timestamp:

06/27/05 21:47:09 (19 years ago)

Author:

Mihaly Barasz

Branch:

default

Phase:

public

Convert:

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

Message:

getstart improvements

File:

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

doc/getstart.dox

@@ -2 +2 @@
 \page getstart How to start using LEMON
 
-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. We assume that you have a
-basic knowledge of your operating system and \c C++ or \c C 
-programming language. 
+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. We assume that you
+have a basic knowledge of your operating system and \c C++ programming
+language. The procedure is pretty straightforward, but if you have any
+difficulties don't hesitate to
+<a href="http://lemon.cs.elte.hu/mailinglists.html">ask</a>.
 
 \section requirementsLEMON Hardware and software requirements
 
-Hardware requirements ...
+In LEMON we use C++ templates heavily, thus compilation takes a
+considerable amount of time and memory. So some decent box would be
+advantageous. But otherwise there are no special 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. 
+You will need a recent C++ compiler. Our primary target is the GNU C++
+Compiler (g++), from version 3.3 upwards. We also checked the Intel C
+compiler (icc). Microsoft Visual C++ .NET version was also reported to
+work (but not the earlier versions). If you want to develop with LEMON
+under Windows you could consider using 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.
+In this description we will suppose a linux environment and GNU C Compiler.
 
 \section downloadLEMON How to download LEMON
 
 You can download LEMON from the LEMON web site:
-http://lemon.cs.elte.hu/dowload.html
-. 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.
+http://lemon.cs.elte.hu/dowload.html.
+There you will find released versions 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.
 
 
@@ -38 +41 @@
 In order to install LEMON you have to do the following
 
-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:
+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 <tt>lemon-0.3.1.tar.gz</tt>) and issue the following
+commands:
 
-\code
+\verbatim
 tar xvzf lemon-0.3.1.tar.gz
 cd lemon-0.3.1
 ./configure
 make
-make check (This is optional, but recomended. It runs a bunch of tests.)
+make check   #(This is optional, but recomended. It runs a bunch of tests.)
 make install
-\endcode
+\endverbatim
 
-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.
+These commands install LEMON under \c /usr/local (you will
+need 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.
 
 We briefly explain these commands below.
 
-\code
+\verbatim
 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>.
+\endverbatim
+This command untars the <tt>tar.gz</tt> file into a directory named <tt>
+lemon-0.3.1</tt>.
 
-\code
+\verbatim
 cd lemon-0.3.1
-\endcode
+\endverbatim
 Enters the directory.
 
-\code
+\verbatim
 ./configure
-\endcode
+\endverbatim
 Does some configuration (creates makefiles etc).
+\todo Explain the most important switches here (gui, doc, glpk, cplex).
 
-\code
+\verbatim
 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.
+\endverbatim
+This command compiles the non-template part of LEMON into
+<b>libemon.a</b> file. It also compiles some benchmark and demo
+programs.
 
-\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.
+\verbatim
+make check
+\endverbatim
+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
+\verbatim
 make install
-\endcode
+\endverbatim
 This will copy the directory structure to its final destination (e.g. to \c
-/usr/local) so that your system can access it.
+/usr/local) so that your system can access it. This command should
+be issued as "root", unless you provided a \c --prefix switch to
+the \c cofugure to install the library in non-default location.
 
 \section helloworld My first program using LEMON
 
-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.
+If you have installed LEMON on your system you can paste the
+following code segment into a file (named e.g. \c hello_lemon.cc)
+to have a first working program that uses library LEMON.
 
 \code
@@ -104 +114 @@
 #include <lemon/list_graph.h>
 
-using namespace lemon;
-
 int main()
 {
-  typedef ListGraph Graph;
+  typedef lemon::ListGraph Graph;
   typedef Graph::EdgeIt EdgeIt;
   typedef Graph::NodeIt NodeIt;
+  using lemon::INVALID;
 
   Graph g;
@@ -130 +139 @@
     std::cout << " (" << g.id(g.source(i)) << "," << g.id(g.target(i)) << ")";
   std::cout << std::endl;
-
+}
 \endcode
 
@@ -151 +160 @@
 \c source member functions can be used to access the endpoints of an edge.
 
-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
+If you have saved the preceding code into a file named, say, \c
+hello_lemon.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):
 
-As a result you will get the exacutable \c hemon in
+\verbatim
+g++ hello_lemon.cc -o hello_lemon -lemon
+\endverbatim
+
+As a result you will get the exacutable \c hello_lemon in
 this directory that you can run by the command 
-\code
-./hemon
-\endcode
+\verbatim
+./hello_lemon
+\endverbatim
 
 
-If everything has gone well then the previous code fragment prints out the following:
+If everything has gone well then the previous code fragment prints
+out the following:
 
-\code
+\verbatim
 Nodes: 2 1 0
 
 Edges: (0,2) (1,2) (0,1) (2,1) (1,0) (2,0)
-\endcode
+\endverbatim
 
 Congratulations!
 
-If you want to see more features, go to the \ref quicktour "Quick Tour to
-LEMON", if you want to see see some demo programs then go to our 
+If you want to see more features, go to the
+\ref quicktour "Quick Tour to LEMON",
+if you want to see see some demo programs then go to our 
 \ref demoprograms "Demo Programs" page!