[Lemon-commits] Peter Kovacs: Improve intro and getting started ...

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon-tutorial/rev/66d164ef72d1
changeset: 25:66d164ef72d1
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Sun Feb 14 21:26:31 2010 +0100
description:
	Improve intro and getting started pages

diffstat:

 getting_started.dox |  18 +++++++++++-------
 intro.dox           |  17 +++++++++--------
 2 files changed, 20 insertions(+), 15 deletions(-)

diffs (85 lines):

diff --git a/getting_started.dox b/getting_started.dox
--- a/getting_started.dox
+++ b/getting_started.dox
@@ -20,17 +20,21 @@
 /**
 [PAGE]hello_lemon[PAGE] Compile Your First Code
 
-First of all you have to install LEMON on your system (see
-<a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>our
-web page</b></a> for instructions).
-After that you can paste the following code segment into a file
-<tt>hello_lemon.cc</tt> to have a first working program that uses LEMON.
+First of all, you have to install LEMON on your system (see the
+<a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>Installation
+Guide</b></a> for instructions).
+In this section, we assume that you use a Linux environment and
+<a href="http://gcc.gnu.org/">GCC</a> compiler.
+
+Once you have installed the library, you may paste the following code segment
+into a file <tt>hello_lemon.cc</tt> to have a first working program that uses
+LEMON.
 
 \dontinclude hello_lemon.cc
 \skip #include
 \until }
 
-In this small example a directed graph is created with two nodes and
+In this small example, a directed graph is created with two nodes and
 an arc added to it.
 
 Now let us compile this code.
@@ -69,7 +73,7 @@
 
 If you managed to compile and run this example code without any problems,
 you may go on reading this tutorial to get to know the basic notions,
-features and tools of LEMON. However if you encountered problems that
+features and tools of LEMON. However, if you encountered problems that
 you did not manage to solve, do not hesitate to
 <a href="mailto:lemon-user at lemon.cs.elte.hu"><b>contact us</b></a>.
 
diff --git a/intro.dox b/intro.dox
--- a/intro.dox
+++ b/intro.dox
@@ -22,24 +22,25 @@
 [SEC]intro_lemon[SEC] What is LEMON
 
 <b>LEMON</b> stands for <b>L</b>ibrary for <b>E</b>fficient <b>M</b>odeling and
-<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template
-library aimed at combinatorial optimization tasks, especially those
-working with graphs and networks.
+<b>O</b>ptimization in <b>N</b>etworks. It is a C++ template library providing
+efficient implementations of common data structures and algorithms with
+focus on combinatorial optimization tasks connected mainly with graphs
+and networks. 
 
 <b>LEMON is an <a class="el" href="http://opensource.org/">open source</a>
 project.
 You are free to use it in your commercial or non-commercial applications
 under very permissive \ref license "license terms".</b>
 
-This library helps to write programs that solve optimization problems
-that arise frequently when designing and testing certain networks,
+This library helps to write programs that solve various optimization problems,
+which often arise when designing and testing certain networks,
 for example in telecommunication, computer networks, logistics, scheduling,
 and other areas.
 A very natural way of modelling these networks is by means of a graph.
-Generally if you want to write any program that works with graphs,
+Generally, if you want to write any program that works with graphs,
 then you might find it useful and convenient to use LEMON.
 
-For more information visit the LEMON web site:
+For more information, visit the LEMON web site:
 <a href="http://lemon.cs.elte.hu/"><b>http://lemon.cs.elte.hu/</b></a>.
 
 [SEC]intro_tutorial[SEC] LEMON Tutorial
@@ -49,7 +50,7 @@
 power of various tools implemented in the library.
 
 After getting familiar with the basics of the library, you may start using
-LEMON with the help of the detailed documentation (that can also be used
+LEMON with the help of the detailed documentation (which can be viewed
 as a reference manual).