Improve intro and getting started pages
authorPeter Kovacs <kpeter@inf.elte.hu>
Sun, 14 Feb 2010 21:26:31 +0100
changeset 2566d164ef72d1
parent 24 2965b19071f7
child 26 a40eafb6066d
Improve intro and getting started pages
getting_started.dox
intro.dox
     1.1 --- a/getting_started.dox	Mon May 11 16:36:11 2009 +0200
     1.2 +++ b/getting_started.dox	Sun Feb 14 21:26:31 2010 +0100
     1.3 @@ -20,17 +20,21 @@
     1.4  /**
     1.5  [PAGE]hello_lemon[PAGE] Compile Your First Code
     1.6  
     1.7 -First of all you have to install LEMON on your system (see
     1.8 -<a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>our
     1.9 -web page</b></a> for instructions).
    1.10 -After that you can paste the following code segment into a file
    1.11 -<tt>hello_lemon.cc</tt> to have a first working program that uses LEMON.
    1.12 +First of all, you have to install LEMON on your system (see the
    1.13 +<a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>Installation
    1.14 +Guide</b></a> for instructions).
    1.15 +In this section, we assume that you use a Linux environment and
    1.16 +<a href="http://gcc.gnu.org/">GCC</a> compiler.
    1.17 +
    1.18 +Once you have installed the library, you may paste the following code segment
    1.19 +into a file <tt>hello_lemon.cc</tt> to have a first working program that uses
    1.20 +LEMON.
    1.21  
    1.22  \dontinclude hello_lemon.cc
    1.23  \skip #include
    1.24  \until }
    1.25  
    1.26 -In this small example a directed graph is created with two nodes and
    1.27 +In this small example, a directed graph is created with two nodes and
    1.28  an arc added to it.
    1.29  
    1.30  Now let us compile this code.
    1.31 @@ -69,7 +73,7 @@
    1.32  
    1.33  If you managed to compile and run this example code without any problems,
    1.34  you may go on reading this tutorial to get to know the basic notions,
    1.35 -features and tools of LEMON. However if you encountered problems that
    1.36 +features and tools of LEMON. However, if you encountered problems that
    1.37  you did not manage to solve, do not hesitate to
    1.38  <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
    1.39  
     2.1 --- a/intro.dox	Mon May 11 16:36:11 2009 +0200
     2.2 +++ b/intro.dox	Sun Feb 14 21:26:31 2010 +0100
     2.3 @@ -22,24 +22,25 @@
     2.4  [SEC]intro_lemon[SEC] What is LEMON
     2.5  
     2.6  <b>LEMON</b> stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling and
     2.7 -<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
     2.8 -library aimed at combinatorial optimization tasks, especially those
     2.9 -working with graphs and networks.
    2.10 +<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template library providing
    2.11 +efficient implementations of common data structures and algorithms with
    2.12 +focus on combinatorial optimization tasks connected mainly with graphs
    2.13 +and networks. 
    2.14  
    2.15  <b>LEMON is an <a class="el" href="http://opensource.org/">open&nbsp;source</a>
    2.16  project.
    2.17  You are free to use it in your commercial or non-commercial applications
    2.18  under very permissive \ref license "license terms".</b>
    2.19  
    2.20 -This library helps to write programs that solve optimization problems
    2.21 -that arise frequently when designing and testing certain networks,
    2.22 +This library helps to write programs that solve various optimization problems,
    2.23 +which often arise when designing and testing certain networks,
    2.24  for example in telecommunication, computer networks, logistics, scheduling,
    2.25  and other areas.
    2.26  A very natural way of modelling these networks is by means of a graph.
    2.27 -Generally if you want to write any program that works with graphs,
    2.28 +Generally, if you want to write any program that works with graphs,
    2.29  then you might find it useful and convenient to use LEMON.
    2.30  
    2.31 -For more information visit the LEMON web site:
    2.32 +For more information, visit the LEMON web site:
    2.33  <a href="http://lemon.cs.elte.hu/"><b>http://lemon.cs.elte.hu/</b></a>.
    2.34  
    2.35  [SEC]intro_tutorial[SEC] LEMON Tutorial
    2.36 @@ -49,7 +50,7 @@
    2.37  power of various tools implemented in the library.
    2.38  
    2.39  After getting familiar with the basics of the library, you may start using
    2.40 -LEMON with the help of the detailed documentation (that can also be used
    2.41 +LEMON with the help of the detailed documentation (which can be viewed
    2.42  as a reference manual).
    2.43  
    2.44