kpeter@3: /* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@3:  *
kpeter@3:  * This file is a part of LEMON, a generic C++ optimization library.
kpeter@3:  *
kpeter@32:  * Copyright (C) 2003-2010
kpeter@3:  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@3:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@3:  *
kpeter@3:  * Permission to use, modify and distribute this software is granted
kpeter@3:  * provided that this copyright notice appears in all copies. For
kpeter@3:  * precise terms see the accompanying LICENSE file.
kpeter@3:  *
kpeter@3:  * This software is provided "AS IS" with no warranty of any kind,
kpeter@3:  * express or implied, and with no claim as to its suitability for any
kpeter@3:  * purpose.
kpeter@3:  *
kpeter@3:  */
kpeter@3: 
kpeter@11: namespace lemon {
kpeter@3: /**
kpeter@26: [PAGE]sec_hello_lemon[PAGE] Compile Your First Code
kpeter@6: 
kpeter@25: First of all, you have to install LEMON on your system (see the
kpeter@25: <a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>Installation
kpeter@25: Guide</b></a> for instructions).
kpeter@25: In this section, we assume that you use a Linux environment and
kpeter@25: <a href="http://gcc.gnu.org/">GCC</a> compiler.
kpeter@25: 
kpeter@25: Once you have installed the library, you may paste the following code segment
kpeter@25: into a file <tt>hello_lemon.cc</tt> to have a first working program that uses
kpeter@25: LEMON.
kpeter@6: 
kpeter@6: \dontinclude hello_lemon.cc
kpeter@6: \skip #include
kpeter@6: \until }
kpeter@6: 
kpeter@25: In this small example, a directed graph is created with two nodes and
kpeter@16: an arc added to it.
kpeter@6: 
kpeter@16: Now let us compile this code.
kpeter@16: (We suppose that you have it in a file called <tt>hello_lemon.cc</tt>.)
kpeter@6: 
kpeter@16: If LEMON is installed <b>system-wide</b> (into directory \c /usr/local),
kpeter@9: then it is very easy to compile this program with the
kpeter@6: following command (the argument <tt>-lemon</tt> tells the compiler
kpeter@16: that we are using the installed LEMON).
kpeter@6: 
kpeter@6: \verbatim
deba@23: g++ -o hello_lemon hello_lemon.cc -lemon
kpeter@6: \endverbatim
kpeter@6: 
kpeter@6: As a result you will get the exacutable \c hello_lemon in the current
kpeter@6: directory, which you can run by the following command.
kpeter@6: 
kpeter@6: \verbatim
kpeter@6: ./hello_lemon
kpeter@6: \endverbatim
kpeter@6: 
kpeter@16: If LEMON is installed <b>user-local</b> into a directory
kpeter@18: (e.g. <tt>~/lemon</tt>), then compiling the code is a bit more difficult.
kpeter@6: You have to issue a command like this.
kpeter@6: 
kpeter@6: \verbatim
deba@23: g++ -o hello_lemon -I ~/lemon/include hello_lemon.cc -L ~/lemon/lib -lemon
kpeter@6: \endverbatim
kpeter@6: 
kpeter@6: If everything has gone well, then our program prints out the followings.
kpeter@6: 
kpeter@6: \verbatim
kpeter@16: Hello World! This is LEMON library here.
kpeter@16: We have a directed graph with 2 nodes and 1 arc.
kpeter@6: \endverbatim
kpeter@6: 
kpeter@6: If you managed to compile and run this example code without any problems,
kpeter@16: you may go on reading this tutorial to get to know the basic notions,
kpeter@25: features and tools of LEMON. However, if you encountered problems that
kpeter@16: you did not manage to solve, do not hesitate to
kpeter@6: <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
kpeter@6: 
alpar@10: [TRAILER]
kpeter@3: */
kpeter@11: }