1.1 --- a/install.dox	Fri Oct 24 13:34:04 2008 +0100
     1.2 +++ b/install.dox	Tue Oct 28 18:54:30 2008 +0100
     1.3 @@ -19,9 +19,9 @@
     1.4  /**
     1.5  \page install Installation Guide
     1.6  
     1.7 -In this page we detail how to start using LEMON, from downloading it to
     1.8 -your computer, through the steps of installation, to showing a simple
     1.9 -"Hello World" type program that already uses LEMON. We assume that you
    1.10 +In this section we detail how to start using LEMON, from downloading it
    1.11 +to your computer, through the steps of installation, to showing how to
    1.12 +compile programs that use LEMON. We assume that you
    1.13  have a basic knowledge of your operating system and C++ programming
    1.14  language. The procedure is pretty straightforward, but if you have any
    1.15  difficulties do not hesitate to
    1.16 @@ -41,10 +41,10 @@
    1.17  
    1.18  In this description we will suppose a Linux environment and GNU C++ Compiler.
    1.19  If you would like to develop under Windows and use a Windows installer,
    1.20 -you could skip the following sections and continue reading \ref hello_lemon.
    1.21 +you could skip the following sections and continue reading
    1.22 +\ref basic_concepts.
    1.23  However keep in mind that you have to make appropriate steps instead of
    1.24 -the instructions detailed here to be able to compile the example code
    1.25 -with your compiler.
    1.26 +the instructions detailed here to be able to use LEMON with your compiler.
    1.27  
    1.28  \subsection requirements_lp LP Solver Requirements
    1.29  
    1.30 @@ -97,9 +97,6 @@
    1.31  ./configure --prefix=/home/username/lemon
    1.32  \endverbatim
    1.33  
    1.34 -In what follows we will assume that you were able to install to directory
    1.35 -\c /usr/local, otherwise some extra care is to be taken to use the library.
    1.36 -
    1.37  We briefly explain these commands below.
    1.38  
    1.39  \verbatim
    1.40 @@ -144,10 +141,10 @@
    1.41  Several other configure flags can be passed to <tt>./configure</tt>.
    1.42  For more information see the <b><tt>INSTALL</tt></b> file.
    1.43  
    1.44 -\subsection install_hg Install the latest development version
    1.45 +\subsection install_hg Install the Latest Development Version
    1.46  
    1.47  You can also use the latest (developer) version of LEMON from our Mercurial
    1.48 -repository. You need a couple additional tool for that
    1.49 +repository. You need a couple additional tool for that.
    1.50  
    1.51  - <a href="http://www.selenic.com/mercurial">Mercurial</a>
    1.52    - for obtaining the latest code (and for contributing into it)
    1.53 @@ -160,7 +157,7 @@
    1.54    - for generating the documentations (optional, but recommended)
    1.55  
    1.56  Once you have all these tools installed, the process is fairly easy.
    1.57 -First, you have to get the copy of the lates version.
    1.58 +First, you have to get the copy of the latest version.
    1.59  
    1.60  \verbatim
    1.61  hg clone http://lemon.cs.elte.hu/hg/lemon-main lemon-src
    1.62 @@ -181,9 +178,55 @@
    1.63  make install
    1.64  \endverbatim
    1.65  
    1.66 -To generate the documentation, just run 
    1.67 +To generate the documentation, just run
    1.68  \verbatim
    1.69  make html
    1.70  \endverbatim
    1.71 +\todo Is <tt><b>make html</b></tt> really necessary after
    1.72 +<tt><b>make install</b></tt>?
    1.73 +
    1.74 +
    1.75 +\section install_rpm Install from rpm
    1.76 +
    1.77 +\todo Write this section (\ref install_rpm).
    1.78 +
    1.79 +
    1.80 +\section install_user Install Locally to the User
    1.81 +
    1.82 +\todo Write this section (\ref install_user).
    1.83 +
    1.84 +
    1.85 +\section compile_codes Compile Codes that Use LEMON
    1.86 +
    1.87 +Now let us see how to use the library after installing it.
    1.88 +
    1.89 +\subsection compile_system_wide If LEMON is Installed System-Wide
    1.90 +
    1.91 +If your installation of LEMON into directory \c /usr/local was
    1.92 +successful, then you have to issue a command like this to compile a
    1.93 +source file that uses LEMON.
    1.94 +
    1.95 +\verbatim
    1.96 +g++ -lemon [other options] <source file>
    1.97 +\endverbatim
    1.98 +
    1.99 +The argument <tt>-lemon</tt> tells the compiler that we are using the
   1.100 +installed library LEMON.
   1.101 +
   1.102 +\subsection compile_user_local If LEMON is Installed User-Local
   1.103 +
   1.104 +You have to give more options to the compiler if LEMON is installed
   1.105 +user-local into a directory (denoted by <tt><dir></tt>)
   1.106 +or if you just skipped the step <tt>make install</tt>.
   1.107 +In the later case <tt><dir></tt> denotes the directory in which the
   1.108 +the \c make command have been performed.
   1.109 +
   1.110 +\verbatim
   1.111 +g++ -lemon -I <dir> -L <dir>/lemon/.libs [other options] <source file>
   1.112 +\endverbatim
   1.113 +
   1.114 +\subsubsection compile_use_pkg_config Use pkg-config
   1.115 +
   1.116 +\todo Write this sub-subsection (\ref compile_use_pkg_config).
   1.117  
   1.118  */