getting_started.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Mon, 01 Mar 2010 02:30:00 +0100
changeset 58 10b6a5b7d4c0
parent 32 ef12f83752f6
permissions -rw-r--r--
Improve Algorithms section (it is still under construction)
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2010
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 namespace lemon {
    20 /**
    21 [PAGE]sec_hello_lemon[PAGE] Compile Your First Code
    22 
    23 First of all, you have to install LEMON on your system (see the
    24 <a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>Installation
    25 Guide</b></a> for instructions).
    26 In this section, we assume that you use a Linux environment and
    27 <a href="http://gcc.gnu.org/">GCC</a> compiler.
    28 
    29 Once you have installed the library, you may paste the following code segment
    30 into a file <tt>hello_lemon.cc</tt> to have a first working program that uses
    31 LEMON.
    32 
    33 \dontinclude hello_lemon.cc
    34 \skip #include
    35 \until }
    36 
    37 In this small example, a directed graph is created with two nodes and
    38 an arc added to it.
    39 
    40 Now let us compile this code.
    41 (We suppose that you have it in a file called <tt>hello_lemon.cc</tt>.)
    42 
    43 If LEMON is installed <b>system-wide</b> (into directory \c /usr/local),
    44 then it is very easy to compile this program with the
    45 following command (the argument <tt>-lemon</tt> tells the compiler
    46 that we are using the installed LEMON).
    47 
    48 \verbatim
    49 g++ -o hello_lemon hello_lemon.cc -lemon
    50 \endverbatim
    51 
    52 As a result you will get the executable \c hello_lemon in the current
    53 directory, which you can run by the following command.
    54 
    55 \verbatim
    56 ./hello_lemon
    57 \endverbatim
    58 
    59 If LEMON is installed <b>user-local</b> into a directory
    60 (e.g. <tt>~/lemon</tt>), then compiling the code is a bit more difficult.
    61 You have to issue a command like this.
    62 
    63 \verbatim
    64 g++ -o hello_lemon -I ~/lemon/include hello_lemon.cc -L ~/lemon/lib -lemon
    65 \endverbatim
    66 
    67 If everything has gone well, then our program prints out the followings.
    68 
    69 \verbatim
    70 Hello World! This is LEMON library here.
    71 We have a directed graph with 2 nodes and 1 arc.
    72 \endverbatim
    73 
    74 If you managed to compile and run this example code without any problems,
    75 you may go on reading this tutorial to get to know the basic notions,
    76 features and tools of LEMON. However, if you encountered problems that
    77 you did not manage to solve, do not hesitate to
    78 <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
    79 
    80 [TRAILER]
    81 */
    82 }